Splitting comments into standard sections
Ned Konz
ned at bike-nomad.com
Fri Apr 19 05:36:57 UTC 2002
On Thursday 18 April 2002 10:13 pm, David Faden wrote:
> The main advantage I see to labeling the comment sections in a
> consistent way is making it easier for other code to pick out the
> labeled sections. For example, I imagine a search program indexing
> methods by example, specification, and general comment, then
> allowing people to search in one or more of these categories. Also,
> perhaps it would make the distinction between an inline
> specification and a code example more clear to someone browsing the
> code.
Machine-readable formatting of comments is much less important in
Smalltalk than in, say, Java.
We could just add various kinds of comments somewhere else, and make
the browsers (optionally) display them. The ClassOrganizers come to
mind, since they have little else to do.
Since everything is in the image (or can be made to appear in the
file-outs and/or modules), we don't have to limit ourselves to
comments at the top of method source like Java does.
--
Ned Konz
http://bike-nomad.com
GPG key ID: BEEA7EFE
More information about the Squeak-dev
mailing list
|