Javadoc

  /**      */

• JavaDoc guide on Oracle Java SE documentation page
• javadoc tags
• Rectangle.java - a simple class that contains Javadoc comments
• Javadoc pages generated for Rectangle class, when the following command is run:

    javadoc Rectangle.java
  

• Javadoc pages generated for Rectangle class, when the following command is run:

    javadoc -link https://docs.oracle.com/javase/17/docs/api/ -link . -private 
            -linksource -author Rectangle.java 
  

  Note that this one uses some extra command line options:
  • -link: specifies that pages will create links to outside classes, given in the location after the phrase -link
  • -private: shows all classes and members in documentation
  • -linksource: creates html version of source code file, with line numbers, linked in to documentation
  • -author: includes the text from the author label in the documentation
  • There are many other command line options -- this is just a sampling. See Javadoc pages for full details