Forums Register Login

Documeting the design decisions

+Pie Number of slices to send: Send
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?
+Pie Number of slices to send: Send
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
There's a way to do it better - find it. -Edison. A better tiny ad:
a bit of art, as a gift, that will fit in a stocking
https://gardener-gift.com


reply
reply
This thread has been viewed 473 times.
Similar Threads
GUI Design - Max's Book
How to better structure the choices document?
SCEA part-2 help
How to commit files in svn with ant task
recent movies (after 1990)
More...

All times above are in ranch (not your local) time.
The current ranch time is
Mar 28, 2024 15:04:02.