Javadoc (originally cased JavaDoc)Now cased as 'Javadoc'. See . Originally cased as 'JavaDoc'. See  is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to /ref>
The "doc comments" format. used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs, IntelliJ IDEA, NetBeans and Eclipse like IntelliJ IDEA, NetBeans and Eclipse, automatically generate Javadoc HTML. Many file editors assist the user in producing Javadoc source and use the Javadoc info as internal references for the programmer.
Javadoc also provides an API for creating doclets and taglets, which allows users to analyze the structure of a Java application. This is how JDiff can generate reports of what changed between two versions of an API.
Javadoc does not affect performance in Java as all comments are removed at compilation time. Writing comments and Javadoc is for better understanding the code and thus better maintaining it.
Javadoc was an early Java language documentation generator.. Prior to the use of documentation generators it was customary to use technical writers who would typically write only standalone documentation for the software, but it was much harder to keep this documentation in sync with the software itself.
Javadoc has been used by Java since the first release, and is usually updated upon every new release of the Java Development Kit.
The basic structure of writing document comments is to embed them inside
/** ... */. The Javadoc is written next to the items
without any separating newline. Note that any import statements must precede the class declaration. The class declaration usually
For methods there is (1) a short, concise, one line description to
explain what the item does. This is followed by (2) a longer
description that may span multiple paragraphs. The details
can be explained in full here. This section is
optional. Lastly, there is (3) a tag section to list the accepted input
arguments and return values of the method. Note that all of the
Javadoc is treated as HTML so the multiple paragraph sections
are separated by a "<p>" paragraph break tag.
Variables are documented similarly to methods with the exception that
part (3) is omitted. Here the variable contains only the short
Note that it is not recommended to define multiple variables in a single documentation comment. This is because Javadoc reads each variable and places them separately to the generated HTML page with the same documentation comment that is copied for all fields.
Instead, it is recommended to write and document each variable separately: