Class comments!?
Ned Konz
ned at squeakland.org
Mon Oct 25 04:22:37 UTC 2004
On Tuesday 12 October 2004 15:34, goran.krampe at bluefish.se wrote:
> Please tell me something went hideously wrong when all the Multilingual
> classes went in? I mean - a quick look shows that only Locale has a
> class comment! So that is about 80 (!!) classes without class comments.
And now this thread has gotten to about 80 messages.
I wonder whether the time spent discussing the missing comments couldn't have
been put to better use actually commenting them.
Instead of spending the time to fuel a largely pointless discussion, we could
have read the code and figured out first-rate comments for it.
Perhaps the average time to write an email is less than the time to write a
class comment. However, the educational opportunity is generally less.
You know, if we had gotten together on the list or the Swiki and tried to
document those classes we all would have learned something and actually
contributed to the state of Squeak.
Though I agree with the usefulness of some documentation (having had to
reverse-engineer the intent and implementation of some of those classes
myself) and am guilty (having not actually commented them myself once I
figured them out), I can also see that some time from the community to help
the comments might be useful.
Thanks in advance,
--
Ned Konz
http://bike-nomad.com/squeak
More information about the Squeak-dev
mailing list
|