Java - Javadoc

> Procedural Languages > Java

1 - About

Javadoc bundle two concepts:

  • the Javadoc syntax
  • the Javadoc tool to generate the doc
Advertising

3 - Syntax

/**
 *
 * @see <a href="http://gerardnico.com">Wiki articles</a>
 */

3.2 - Author

/**
 *
 * @author Nicolas GERARD
 */
{@link  package.class#member  label} 

Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class.

As a method is a member:

{@link  #myMethod  label} 

3.4 - inheritDoc

/**
* {@inheritDoc}
*/

3.5 - List

in a HTML - UL element (unordered list)

<ul>
    <li>UTF-8 - {@link ByteOrderMark#UTF_8}</li>
    <li>UTF-16BE - {@link ByteOrderMark#UTF_16LE}</li>
    <li>UTF-16LE - {@link ByteOrderMark#UTF_16BE}</li>
   <li>UTF-32BE - {@link ByteOrderMark#UTF_32LE}</li>
   <li>UTF-32LE - {@link ByteOrderMark#UTF_32BE}</li>
</ul>
Advertising

3.6 - Code

in a HTML - Pre (Preserve)

<pre>
   BOMInputStream bomIn = new BOMInputStream(in);
    if (bomIn.hasBOM()) {
       // has a UTF-8 BOM
    }
</pre>

3.7 - Version

@version $Id$

3.8 - Since

@since 2.0

4 - Documentation / Reference