1. 类和接口的文档注释：
/**
* 这是一个示例类，用于演示文档注释的格式和内容。
* 类的详细描述可以写在这里，可以包含类的用途、设计目的等信息。
*
* @author Your Name
* @version 1.0
*/
public class MyClass {
// 类的成员和方法
}
2. 方法的文档注释：
/**
* 这是一个示例方法，用于演示文档注释的格式和内容。
* 方法的详细描述可以写在这里，可以包含方法的用途、参数说明、返回值说明等信息。
*
* @param param1 参数1的说明
* @param param2 参数2的说明
* @return 返回值的说明
*/
public int myMethod(int param1, String param2) {
// 方法的实现
return 42;
}
3. 字段的文档注释：
/**
* 这是一个示例字段，用于演示文档注释的格式和内容。
* 字段的详细描述可以写在这里，可以包含字段的用途、取值范围等信息。
*/
private String myField;
4. 文档注释标签：
在文档注释中，可以使用一些预定义的标签来提供额外的信息，例如 @author、@version、@param、@return 等。
- @param: 用于描述方法的参数。
/**
* 计算两个数的和。
*
* @param a 第一个加数
* @param b 第二个加数
* @return 两个数的和
*/
public int add(int a, int b) {
return a + b;
}
- @return: 用于描述方法的返回值。
/**
* 获取学生的年龄。
*
* @return 学生的年龄
*/
public int getAge() {
return age;
}
- @throws 或 @exception: 用于描述方法可能抛出的异常。
/**
* 除法操作。
*
* @param dividend 被除数
* @param divisor 除数
* @return 除法结果
* @throws ArithmeticException 如果除数为零
*/
public int divide(int dividend, int divisor) throws ArithmeticException {
if (divisor == 0) {
throw new ArithmeticException("Division by zero");
}
return dividend / divisor;
}
5. 生成文档：
要生成文档，可以使用 javadoc 工具。在命令行中，切换到包含源代码的目录，并运行以下命令：
javadoc -d docs *.java
这将在当前目录下的 docs 文件夹中生成文档。
以上是 Java 文档注释的基本用法。文档注释对于代码的可读性和维护性非常有帮助，同时也方便了生成代码文档。
转载请注明出处：http://www.zyzy.cn/article/detail/440/Java