A modest proposal... DOCUMENT!

Lex Spoon lex at cc.gatech.edu
Fri Feb 18 00:36:07 UTC 2000


"Charles-A. Rovira" <crovira at wt.net> wrote:
> I defintely agree with Lars.
> 
> The lack of documentation as to the intent of a class (why is this thing even in here,) the structure of its variables (global, pool, class, instance, method and block vars and the classes the var can take would halp a lot, (a parameter called "aCollection" doesn't tell me much about what its a collection _of_ and that may be important,)) the protocols (why is this distinction even in here,) and functionality (why is this method even in here,) along with some EXAMPLES are the biggest hurdles to overcome.
> 

As an aside, usually a parameter named "aCollection" really can be an
arbitrary collection.  Agreed that if it should contain something more
specific, then the variable should be renamed.  But I haven't noticed
too many instances of this.

I *have* noticed a number of classes that don't have comments, however
:)

Lex





More information about the Squeak-dev mailing list