javadoc

// 示例代码：使用 Javadoc 注释

/**
 * 这是一个简单的类，用于演示如何编写 Javadoc 注释。
 * 
 * @author 作者名
 * @version 1.0
 */
public class ExampleClass {

    /**
     * 这是一个构造函数，用于初始化 ExampleClass 对象。
     */
    public ExampleClass() {
        // 构造函数的实现
    }

    /**
     * 这是一个示例方法，用于返回两个整数的和。
     *
     * @param a 第一个整数
     * @param b 第二个整数
     * @return 返回两个整数的和
     */
    public int add(int a, int b) {
        return a + b;
    }

    /**
     * 这是一个主方法，用于测试 ExampleClass 类的功能。
     *
     * @param args 命令行参数
     */
    public static void main(String[] args) {
        ExampleClass example = new ExampleClass();
        System.out.println("3 + 5 = " + example.add(3, 5));
    }
}

解释说明：

• /** ... */ 是 Javadoc 注释的语法，用于生成文档。
• @author 标签用于指定类或方法的作者。
• @version 标签用于指定类或方法的版本信息。
• @param 标签用于描述方法的参数。
• @return 标签用于描述方法的返回值。

通过这些注释，开发者可以生成详细的 API 文档，方便其他开发者理解和使用代码。