Documentation... (was Re: Article in Wired)

Peter Smet peter.smet at flinders.edu.au
Mon Jun 7 05:10:54 UTC 1999


Perhaps we could pull ourselves up by our own bootstraps
here and use dandelion to produce a nice HTML formatted
class hierachy. This could constitute a make-shift reference
manual. I agree the html document would still need comments
and examples, but it's a good start.

Peter


>I think it may be worthwhile to stop madly coding for one or two weeks and
>just comment all the classes you've all designed.  It would probably
>improve coding efficiency since most coders will not know the entire Squeak
>hierarchy and may need to use something they have never encountered
>before.  Although they could probably just study the code and figure it
>out, it would probably be a whole lot easier with a simple example that
>describes the operation in detail.
>
>(I've gotta start commenting my classes too! :)
>
>-- Dino
>
>





More information about the Squeak-dev mailing list