This week's book giveaway is in the OO, Patterns, UML and Refactoring forum.
We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes doc design decisions in code?? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "doc design decisions in code??" Watch "doc design decisions in code??" New topic

doc design decisions in code??

Colin Froggatt

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
Have you checked out Aspose?
subject: doc design decisions in code??
jQuery in Action, 3rd edition