9 Sep
2003
9 Sep
'03
9:30 p.m.
I will do them all to be sure that I understand. I guess that roel will
do the same. So you should have a
really good document after.
Please pay attention that we should generate the class description from
the class comment themselves.
This way we are sure that the comments are good.
By the way david was at the apero of roel and he told me that he will
contact you to get in sync with you.
Dragos also told me that he is starting to get into smalltalk which is
excellent.
Stef
9 Sep
9 Sep
10:06 p.m.
Hi Stef,
I will do them all to be sure that I understand. I
guess that roel
will do the same. So you should have a really good document after.
I started writing the documentation yesterday - using TeXShop, that is
really a cool app to start quickly - but having to answer e-mails the
whole day there is no advance ... ;-)
I think that I will wait with the re-factoring of the template
hierarchy for now and just focus on the documentation right now.
Please pay attention that we should generate the class
description
from the class comment themselves. This way we are sure that the
comments are good.
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?
Lukas
--
Lukas Renggli
http://renggli.freezope.org
10 Sep
10 Sep
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
7538
days inactive
7539
days old
2 comments
2 participants
participants (2)
-
ducasse -
Lukas Renggli