Javadoc 是用于生成 Java 代码文档的工具。它利用特定的注释格式,将 Java 源代码中的注释提取出来,并生成 HTML 文档。Javadoc 注释通常位于类、接口、构造函数、方法和字段的声明之前,以 /**
开始,以 */
结束。以下是 Javadoc 注释的一些主要元素和使用方法:
基本语法
Javadoc 注释以 /**
开始,并以 */
结束:
/*** 这是一个示例类。*/
public class Example {/*** 这是一个示例方法。* @param param 示例参数* @return 示例返回值*/public int exampleMethod(int param) {return param * 2;}
}
常用标签
@param
:描述方法的参数。
- 用法:
@param parameterName description
- 示例:
/*** Sets the age of the person.* @param age The age to set.*/
public void setAge(int age) {this.age = age;
}
@return
:描述方法的返回值。
- 用法:
@