Commenting class category

cdrick cdrick65 at gmail.com
Sat Feb 9 13:12:59 UTC 2008


Hi all

All class should have a comment, as methods... ok
But I find class categories too (and method categories maybe). It
might be a quicker way to have a global vision of a system. Maybe this
is done (sort of) in one or the the most important "class" of the
category.

For instance, I find the seaside-callbacks category would be better
explained in its globality first. Class comment provide then more
precise information (especially when there is a hierarchy).

Do you think it would be useful too? I don't know if it's doable. An
easy way would be to add a empty class dedicated to wrinte comments
...

Just a thought :)

Cédrick


More information about the Squeak-dev mailing list