[webkit-dev] coding style and comments

Ryosuke Niwa rniwa at webkit.org
Thu Jan 27 15:55:09 PST 2011

On Thu, Jan 27, 2011 at 3:46 PM, Eric Seidel <eric at webkit.org> wrote:

> My personal preference (and I'd love to hear from other contributors)
> is that code should ideally be self-documenting.

I strongly agree with this point.  One pit-fall of adding comments is that
it gives an illusion of the increased readability.  And I believe making
code self-evident to avoid adding comments has been a good driving force in
cleanup / refactoring WebKit's code base.

On Thu, Jan 27, 2011 at 3:46 PM, Darin Adler <darin at apple.com> wrote:
> We also frown on “textbook” style comments. Long block comments that read
> like a manifesto about what a code or class will do aren’t typical in
> WebKit.

I agree that WebKit code base doesn't usually have a block comment for a
class, function, etc... and new code should follow that convention.

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

More information about the webkit-dev mailing list