aspose file tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes doc design decisions in code?? Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Reply Bookmark "doc design decisions in code??" Watch "doc design decisions in code??" New topic
Author

doc design decisions in code??

Colin Froggatt
Greenhorn

Joined: Feb 26, 2002
Posts: 10
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.
Adam Roberts
Ranch Hand

Joined: Mar 18, 2002
Posts: 71
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
 
I agree. Here's the link: http://zeroturnaround.com/jrebel - it saves me about five hours per week
 
subject: doc design decisions in code??
 
Similar Threads
documentation files, how many needed?
Format for Design Documentation
documentation , how far should we go ?
Documentation question
What does it mean in the instruction ?