[webkit-dev] coding style and comments

[Dirk Pranke]

Hi all,

Have there been any threads or blog posts in the past over an
appropriate level of comments in the code? A brief search of the
Google and the list archives didn't really turn up anything.

>From what I've seen, code in WebKit is much less commented than most
if not all large projects I've worked on. Is this intentional? If so,
why? Also, do we want commenting style to be consistent across
languages in the project?

For example, Python code is usually pretty well commented, but we've
checked in some Python files here with almost no comments, with the
rationale being that "it's WebKit style".

To allay any fears, I'm not suggesting that we should have large
chunks of boilerplate or anything like that. I'm aware as anybody of
the danger of comments being wrong or getting out of sync with the
code.

-- Dirk