[webkit-dev] Class-level comments in the source code

[Ryosuke Niwa]

On Jul 6, 2012 2:36 PM, "Per Bothner" <per.bothner at oracle.com> wrote:
>
> On 07/06/2012 02:18 PM, Ryosuke Niwa wrote:
>> I've found that our culture of not adding comments have given me a
>> pressure to think really hard to come up with better class names rather
>> than going with vague names with explanatory comments. In some cases, it
>> made me realize that the particular object relationships I had in my
>> mind was not a good design and made me come up with a new design that
>> involved easier-to-understand classes.
>
>
> Pressure to come up with good names isn't incompatible with comments ...

It's a problem of incentives. In the world where we write per-class
comments for every class, there might be less incentive or simply time for
coming up with better names because we can always clarify the intent in
comments.

- Ryosuke
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-dev/attachments/20120706/4e2def62/attachment.html>