javadoc

JavaDoc is a documentation tool for the Java programming language. It scans Java source files for documentation comments and generates API reference documentation, typically in HTML, suitable for developers using the code. It is part of the Java Development Kit (JDK) and is widely used to document classes, interfaces, methods, fields, and packages.

Documentation comments are block comments that begin with /** and end with */ and are placed immediately before the declaration they describe. The main body is free text, and structured information is added with special tags such as @param, @return, and @throws for methods, or @author, @version, @since for the class or package.

Inline tags and code formatting can be used within text. For example, {@link ...} creates a hyperlink to other API elements, and {@code ...} formats code inline. The tool understands a variety of standard tags, including @param for parameter descriptions, @return for return values, @throws for exceptions, and @see for cross-references, among others.

Output and usage: The javadoc tool reads the source and produces a set of HTML files, including package summaries, class pages, and navigable indexes. It can be customized with doclets to alter output or generate non-HTML formats. Build systems integrate it via Maven's javadoc plugin or Gradle's javadoc task, and many IDEs provide direct support for generating documentation.

History and scope: JavaDoc originated at Sun Microsystems and has continued under Oracle as part of the JDK. It has evolved with newer Java versions, improving HTML output, navigation, and internationalization. It remains a widely used standard for documenting Java APIs and supporting development workflows.