Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Where to document minor design descisions

 
mike acre
Ranch Hand
Posts: 197
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

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
Posts: 823
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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?"

Jules
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic