Uli: I don't care whether the docs are written before
or after the code, as long as you don't see this as an
excuse not to comment your code.

Alain: You're absolutely right, Uli. Well-commented
code is very important.

Uli: If you extensively comment your code, someone
else can later write the docs while you keep coding
away. If you don't comment, we're all off to a bad
start. Add extensive comments, why a check for a
variable being NULL is there, why you add or subtract
1 to nudge an image, what part of a graphic is drawn,
for what tokens which exception in code handling is.
Mark everything one would have to look up, etc. If we
do that consequently, we'll have maintainable code,
... Else, we'll have to re-write everything every 6
months...

Alain: I wholeheartedly agree.

Uli: if the concept is good.

Alain: That's what documentation BEFORE would be good
for:

1. good design (concept)
2. good planning
3. improved coordination (we are a group after all)
__________________________________________________
Do You Yahoo!?
Thousands of Stores.  Millions of Products.  All in one place.
Yahoo! Shopping: http://shopping.yahoo.com

Reply via email to