A friendly place for programming greenhorns!
Big Moose Saloon
Register / Login
Developer Certification (SCJD/OCMJD)
doc design decisions in code??
Joined: Feb 26, 2002
May 02, 2002 10:50:00
Hi Guy's, I've jsut completed the code and the javadoc but I came across this line in the spec <p>
Design decisions should be clearly but briefly described in your comments.
Now, does this mean in the design doc or in the actual code comments (javadoc)? Any opinions and advice greatfully accepted.
Joined: Mar 18, 2002
May 02, 2002 13:35:00
More in the design.txt than anything.
Javadoc simply tells what each method does, although placing mention of notable design decisions in the javadoc certainly doesnt hurt anything.
Adam Roberts - SCJP2, SCJD<br />insert witty something here
It is sorta covered in the
JavaRanch Style Guide
subject: doc design decisions in code??
Format for Design Documentation
documentation files, how many needed?
What does it mean in the instruction ?
documentation , how far should we go ?
All times are in JavaRanch time: GMT-6 in summer, GMT-7 in winter
| Powered by
Copyright © 1998-2013