This week's book giveaway is in the Design forum.
We're giving away four copies of Design for the Mind and have Victor S. Yocco on-line!
See this thread for details.
Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

doc design decisions in code??

 
Colin Froggatt
Greenhorn
Posts: 10
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 71
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic