up previous next contents
Next: Flow control and loops Up: Comments and Javadoc Previous: A comment example   Contents

Notes on Usage

  • Use the javadoc command to print a separate set of HTML javadoc pages for your classes.
  • See http://java.sun.com/j2se/1.4/docs/api/ for an example of javadoc documentation pages for the Java2 Platform.
  • Comment skew - comments become out of date as the source code changes over time.
  • Some programmers write documentation, others do not.
  • Some businesses have technical writers that end up needing write access to your Java source code files.


up previous next contents
Next: Flow control and loops Up: Comments and Javadoc Previous: A comment example   Contents