Documentation Suggestion

Lex Spoon lex at cc.gatech.edu
Thu Sep 21 18:05:01 UTC 2000


Technically, we've got such a system going already, at least for class
comments.  (It's especially shameful when a *class* doesn't have a
comment!)  I guess it's died down, though.  I can't even seem to find the
old message that kicked it off.

Anyway, the system was that the header contain something like
[COMM] for a changeset that comments things.  Someone had volunteered to
gather these posts up and ensure that they eventually make it into the
standard update stream.

It's a fabulous idea, but apparently we need to post something
about it on the Swiki about it or it will just pass from memory.
In the meantime, barring anyone thinking this is a *bad* idea,
everyone post those comments!


(Also, let's *do* post them to the list.  It can be fun to debate
exactly what the nature of False is :))


-Lex



"Jochen F. Rick" <nadja at cc.gatech.edu> wrote:
> Hello,
> 
> one of the problems that Squeak seems to have is documentation inside the 
> code. Although the code is easy to trace through, a few inline comment 
> might really help. I have a suggestion on how more comments could get in 
> there.
> 
> It seems like adding comments to a method or class is not something that 
> somebody has to look through before it makes it into the update stream. 
> So, might it be possible that when people are browsing a class and they 
> figure it out, they can just add the comment, accept it, and then publish it.
> 
> Their Squeak would then contact the update stream server, check to see that
> the code is the same as the code on the server, check to make sure that 
> the server version was equivalent to the old user version, and the add it 
> to the update stream.
> 
> Voila! This seems like a really simple way to add more comments to the 
> system.
> 
> Peace and Luck!
> 
> Je77





More information about the Squeak-dev mailing list