Javadoc and Comments

Considering how much emphasis I placed on the code (and physical database structure and data) being the long-lasting artifacts, it is important to add documentation to our code! Developers need to be able to understand other developers' code, and having Javadoc and comments for complex code is a big help. Always think from the perspective of someone else; imagine in your mind other persons working with your code and how you can make their job easier. However, you also need to find the right balance in the amount of documentation you provide; I tend to do minimal Javadoc in my codejust enough to give them information about given classes, methods, variables, and most important of all, complex logic.

In light of this, you will notice that all our code has comments in them. Also, you will notice it has minimal comments, again everything in moderation, not too much and not too little. By having these comments, I can run the JDK javadoc command against my Java code to generate comprehensive documentation on the code for our sample application.