[webkit-dev] Please include function-level comments in change log entries

Hugo Parente Lima hugo.lima at openbossa.org
Fri Jul 6 11:38:03 PDT 2012

On Friday, July 06, 2012 11:34:01 AM Per Bothner wrote:
> On 07/06/2012 10:05 AM, Dan Bernstein wrote:
> > It appears that lately most WebCore change log entires don’t include any
> > comments on individual functions. An overall description of the change at
> > the top of the change log entry is valuable, but it is no substitute for
> > describing the changes to each function. Good function-level comments are
> > useful both while reviewing a patch and while revisiting existing code.
> > Personally, I find that writing the function-level comments helps me a
> > lot in reviewing my own patches before I post them.
> You forget there is a WebKit policy of not writing comments
> or otherwise documenting the code.

I think he meant function level comments on ChangeLogs, not on the code 
> Or at least that's what it looks like. :-(
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20120706/4ae9f707/attachment.bin>

More information about the webkit-dev mailing list