Class comments!?

Blake blake at kingdomrpg.com
Thu Oct 14 06:13:07 UTC 2004


On Wed, 13 Oct 2004 21:55:50 -0600, John Pfersich <jp1660 at att.net> wrote:

> Göran Krampe wrote:
>>
>> I mean, sure, some of these can have short comments - but is it just me
>> getting ANNOYED when there is NO COMMENT AT ALL?!
>>
>> IMHO this is NOT the way to increase quality. Don't get me wrong - I
>> love this stuff getting in and I love and appreciate the work behind it.
>> I still think that classes without class comments AREN'T COMPLETE and
>> that if we never bother to set the standard higher it will NEVER get
>> better.
>>
> Oh c'mon Göran, if it was hard to write those classes, it should be
> hard to use them too. (grin)

I'm anti-comment, myself, with some rare exceptions. Documenting the class  
as a whole might make sense, but comments for each method--particularly in  
Smalltalk--seems, well, redundant.




More information about the Squeak-dev mailing list