Class comments!?

Tim Rowledge tim at sumeru.stanford.edu
Tue Oct 19 22:13:52 UTC 2004


"Doug Way" <dway at mailcan.com> wrote:

>
> Commenting 80 classes might seem a bit daunting, so one approach you
> might take is to pick 10 or 12 of the most important classes in the m17n
> changes, and just comment those.
Or, generically rather than specifically refering to the m17n stuff,
when there are a large number of classes write a comprehensive comment
for one of them and use links in all the others to point back to that
one. That provides the perfect excuse to write about the _system_ the
classes provide rather than trying to tease out comments for each
individual class.

tim
--
Tim Rowledge, tim at sumeru.stanford.edu, http://sumeru.stanford.edu/tim
Strange OpCodes: OKP: On your Knees and Pray!



More information about the Squeak-dev mailing list