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

Per Bothner per.bothner at oracle.com
Fri Jul 6 11:34:01 PDT 2012


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.

Or at least that's what it looks like. :-(
-- 
	--Per Bothner
per.bothner at oracle.com   per at bothner.com   http://per.bothner.com/




More information about the webkit-dev mailing list