JavaDoc

JavaDoc 是 Java 编程语言中用于生成 API 文档的工具。它通过解析 Java 源代码中的特殊格式注释，自动生成 HTML 格式的文档。

JavaDoc 注释格式

JavaDoc 注释以 /** 开头，以 */ 结束，每行以 * 开头。通常放在类、接口、方法或字段的声明之前。JavaDoc 注释可以包含多种标签，用于描述不同的部分。

常用标签

• @author：指定类或接口的作者
• @version：指定类或接口的版本
• @param：描述方法的参数
• @return：描述方法的返回值
• @throws 或 @exception：描述方法可能抛出的异常
• @see：提供相关主题或参考
• @since：指定自哪个版本以来可用
• @deprecated：标记不推荐使用的类、方法或字段

示例

/**
 * This is a simple example class.
 *
 * @author John Doe
 * @version 1.0
 * @since 2023-10-01
 */
public class Example {

    /**
     * Adds two integers.
     *
     * @param a the first integer
     * @param b the second integer
     * @return the sum of a and b
     */
    public int add(int a, int b) {
        return a + b;
    }
}

使用 JavaDoc 工具

可以通过 javadoc 工具来生成文档。

javadoc MyApp.java

这将在当前目录下生成一个 docs 目录，其中包含 HTML 格式的 API 文档。