File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Where to document minor design descisions Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Make it so: Java DB Connections & Transactions this week in the JDBC forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Where to document minor design descisions" Watch "Where to document minor design descisions" New topic

Where to document minor design descisions

mike acre
Ranch Hand

Joined: Sep 23, 2003
Posts: 197

Do not provide comments that do not add to the comprehensibiltiy of the code.

Design choices must be described briefly but clearly in your comments.

These two sentences seem to contradict each other, or is that last word 'comments' not refering to code comments?

Does anyone decide to write minor design descisions in the code comments?

Julian Kennedy
Ranch Hand

Joined: Aug 02, 2004
Posts: 823
That sentence raised the same question for me. I interpreted it as not meaning code comments.

However, I think it's a good idea to justify certain design decisions in code comments, for example where a design choice might cause another developer looking at your code to think "why did he do it that way?" or "how does this bit work then?"

I agree. Here's the link:
subject: Where to document minor design descisions
jQuery in Action, 3rd edition