306 Migrating Applications from WebLogic, JBoss and Tomcat to WebSphere V6
Code documentation
Undocumented code is next to useless. Documentation best practice is
fundamental to the design, implementation and maintenance phases. If code is
not properly documented then code maintenance in subsequent iterations can be
at best problematic, and at worst, impractical. Code maintenance has many sub
areas. Extending applications, scaling applications and fixing applications are all
forms of maintenance. Without good documentation, these tasks are much
harder to complete.
JavaDoc gives developers a contract
JavaDoc is used to document classes, instance variables and methods. It has
very clearly defined annotations that can aid the development process ...