Javadoc

Javadoc ignores comments unless they are specially marked. A Javadoc comment is marked with an extra asterisk after the start of a multi-line comment: /**. Following lines are preceded with an *, and the entire comment block should be terminated with a */. An example of a method Javadoc comment follows: /** * Description of what the method does. * * @param input Description of parameter. * @return Description of return value. * @throws Exception Description of exception. */ public int methodName(String input) throws Exception { ... } Some HTML tags, such as , , and , are supported in Javadoc. == Markdown ==

From Java 23 onwards, Javadoc supports the Markdown standard CommonMark on comment lines that start with /// instead of the older multiline format. == Doclets ==

A Doclet program works with Javadoc to select which content to include in the documentation, format the presentation of the content and create the file that contains the documentation. A Doclet is written in Java and uses the , The included with Javadoc generates API documentation as frame-based HTML files. Other Doclets are available on the web , often for free. These can be used to: • Create other types of documentation (non-API) • Output to a format other than HTML, such as PDF • Output as HTML with additional features such as a search or with embedded UML diagrams generated from the Java classes == Tags ==

Some of the available Javadoc tags are listed in the table below: == See also ==