This week's book giveaway is in the OO, Patterns, UML and Refactoring forum. We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line! See this thread for details.
Hi, My assignment spec says the final submission must have 'JavaDoc documentation for all classes and interfaces you are submitting'. Here are my questions. 1.Many or most of my classes don't have to be public. Should I make all classes public and include doc comments, to meet the above criteria? 2.I have very few public methods in my classes. They all have package level access or private access. Should I include doc comments for such methods? They are not going to be generated anyway in the javadoc.
I also did not make classes public that did not need to be (I think that would be a bad idea that will probably cost you points in the OO or General Considerations categories).
As a habit, I added comments to all methods, even private ones and to all fields that had package level or better visibility. I generated the javadoc using the -package flag. I got the full score in the documentation category, so I guess it was OK.
SCJP 1.4, SCJD
Joined: Mar 05, 2005
Thanks to all who replied. I'll got the same way as you guys.