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

Dan Bernstein mitz at apple.com
Fri Jul 6 10:05:26 PDT 2012


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.

Thanks.


More information about the webkit-dev mailing list