Back to the issue... (was RE: Squeak coding style...)

goran.krampe at bluefish.se goran.krampe at bluefish.se
Wed Mar 3 07:33:22 UTC 2004


Hi all!

"Lex Spoon" <lex at cc.gatech.edu> wrote:
> The only new information that is in LPI
> or LNI is "positive" or "negative", plus possibly "see the superclass". 
> It is not a bad thing if such simple comments are left out entirely.

I think you are forgetting one IMHO very important aspect.
If a class has no class comment at all then I as a reader is left to
figure out if that is because:

A. The class is so obvious that the author assumes all readers can
figure out what is to know about it just by looking at the name of the
class. (Which btw I agree with Tim, is simply not so)
B. ...or the author simply was a sloppy Smalltalker and didn't even
bother to enter a class comment.

Now, how do I as a reader know which is the case? I don't! I have to
read the damn code and after a while I might guess which one it is. To
me this is so obviously wrong that I simply can not understand why
people are even arguing! (And the same goes for method comments btw -
though I agree that there are methods that need not be commented. On the
other hand I find that except for accessors etc most of them *can*
actually be meaningfully commented.)

I mean COME ON! What is the reason for not putting a simple short class
comment into the standard classes in our standard packages? What is so
damn hard and frightening about that?

regards, Göran



More information about the Squeak-dev mailing list