Win a copy of Java Mock Exams (software) this week in the Programmer Certification (OCPJP) forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Documeting the design decisions

 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In M.Habibi book I find something like "write down the various decisions you make and de reason why you make them....".
There are two kinds of desing decisions general and local (why I choose an ArrayList).
The general are placed in readMe files but what happen with the local ? In the code comments?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Posts: 12056
232
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mihai,
If you feel that someone maintaining your code should know why you used an ArrayList rather than any other form of list, then you should put that comment in the code.
If your decision to use an ArrayList impacts the way the application as a whole works, then put in in the design decisions document as well.
Regards, Andrew
 
Happiness is not a goal ... it's a by-product of a life well lived - Eleanor Roosevelt. Tiny ad:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!