[webkit-dev] coding style and comments

[Alexey Proskuryakov]

28.01.2011, в 9:36, Peter Kasting написал(а):

> At the very least I agree with Simon's suggestion of class-level comments, especially w.r.t. ownership.

I remember this comment <http://trac.webkit.org/browser/trunk/WebCore/platform/PlatformString.h?rev=16622#L44> causing trouble. Here is some history if you're interested:

https://bugs.webkit.org/show_bug.cgi?id=11555#c5
https://bugs.webkit.org/show_bug.cgi?id=16550
http://trac.webkit.org/changeset/28977/trunk/WebCore/platform/text/PlatformString.h

This comment has evolved into comments for crossThreadString() and threadsafeCopy() - and while these are useful, they are not up to date, mentioning a non-existent copy() function.

Do you have any specific mechanism in mind for keeping global comments accurate? Personally, I expect that adding such comments will make the barrier for entry higher in practice, as one would have to deal with lies.

- WBR, Alexey Proskuryakov