Java | Javadoc基本使用

Javadoc（最初是JavaDoc）是由Sun Microsystems为Java语言（现在由甲骨文公司拥有）创建的文档生成器，用于从Java源代码生成HTML格式的API文档，HTML格式用于增加将相关文档链接在一起的便利性。

Javadoc的“杀手级功能”是它与Eclipse和其他IDE紧密集成。开发人员只需要将鼠标指针悬停在标识符上即可了解他们需要了解的所有内容。对于经验丰富的Java开发人员而言，不断引用文档已成为其第二天性，从而提高了他们自己代码的质量。如果您的API未随Javadoc一起记录，那么经验丰富的开发人员将不希望使用它。

所有的Javadoc都被视为HTML

参考

官方文档
Javadoc Technology
维基百科
Javadoc
stackoverflow
/** and /* in Java Comments

基本结构

类

// import statements

/**
 * @author     姓名  <address @ example.com>
 * @version    1.6   （程序的当前版本号）
 * @since       1.2    （加入该类时程序的版本号）
 */
public class Test {
    // class body
}

方法

/**
 * 简短的单行描述。                                                  
 * <p>
 * 更长一些的描述可以写在这里。                             
 * </p>
 * 在HTML段落分隔的连续段落中还可以有更多注释。
 *
 * @param  variable 描述文本。                              
 * @return  描述文本。
 */
public int methodName (...) {
    // method body with a return statement
}

变量

/**
 * 简短的单行描述。                                                  
 * <p>
 * 更长一些的描述可以写在这里。                             
 * </p>
 * 在HTML段落分隔的连续段落中还可以有更多注释。
 */
private int debug = 0;

尽量避免单个文档注释中定义多个变量

/**
 * 点的水平距离。
 */
public int x;

/**
 * 点的垂直距离。
 */
public int y;