10 Sep
2003
10 Sep
'03
9:12 a.m.
I agree, but the comments are written like: 'Page: I represent a page
in the wiki-tree of structures ...'. I don't know, if that is a kind
of writing that is useable for documentation? And after all I also
want to give additional comments and ideas, not being inside the
class-comments ... So what should I do?
Focus on the collaboration that a class has with the rest. Most of the
time I know what the class is about. What is most of the time missing is
- when this class is created, who create it,
- when a key method is invoked by whom
Do not explain the basic structure but the important collaborators, and
collaborations
and the key public methods.
- what are the key methods
- what are the key collaboration
(I do that then Y call me....)
You will see that you know a lot of hidden knowledge.
You should state the key hook methods too.
Think that the class comment can replace a part of an UML diagram.
Focus on the behavior because they are objects. Give a try and send
that to the list.
Stef