Javadoc

The content and formatting of a resulting document are controlled via special markup in source code comments.

Some IDEs, like IntelliJ IDEA, NetBeans and Eclipse, support generating Javadoc template comment blocks.

[3] The @tag syntax of Javadoc markup has been re-used by other documentation generators, including Doxygen, JSDoc, EDoc and HeaderDoc.

Javadoc supports extension via doclets and taglets, which allow for generating different output formats and for static analysis of a codebase.

For example: A more complete example follows: From Java 23 onwards, Javadoc supports the Markdown standard CommonMark on comment lines that start with /// instead of the older multiline format.