[webkit-dev] coding style and comments

[Maciej Stachowiak]

On Jan 31, 2011, at 7:18 PM, Peter Kasting wrote:

> This thread has probably gone the way of all webkit-dev threads on comments or ChangeLog files -- people's opinions vary, it turns into a bikeshed, and nothing really changes about how we code.  Repeat in a year.

Well, even though we didn't come to consensus, I hope we benefitted in exposing the silent majority of the list to some strong opinions on code quality, which definitely *is* a key value for the WebKit project, even if we don't have 100% agreement on the means.

I, for one, am happy that we have so many people who care passionately about keeping the code clean and readable.

> 
> w.r.t. ImageDecoder specifically, as I mentioned before I do agree that there are some comments that are either worthless or partially so, and I'll try and post some cleanup for this header on https://bugs.webkit.org/show_bug.cgi?id=53455 .

Would be glad to review any code cleanup if you need me to.

> 
> P.S. I agree with you about assertions being better than comments to document pre- (and post-) conditions (where possible).

I find it very often is, even when it initially seems unlikely, and it's awesome when you run the layout tests in a debug build and see your precondition assertion fail. It's like having regression tests for your comments!

Regards,
Maciej

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20110131/fa501c36/attachment.html>