4.Java中的注释

4.Java中的注释

多行注释不能嵌套/* 内容 */

单行注释/行内注释 // 内容

文档注释：/** 内容 */

文档注释

格式：

/**
 * 描述内容
 * @【标签】 参数说明
 */

常见的标签：

标签	用途	示例
@param	方法参数说明	@param username 用户名
@return	返回值描述（非void方法必需）	@return 操作是否成功
@throws/@exception	抛出异常说明	@throws IOException 文件未找到
@author	作者信息（类/接口注释）	@author ZhangSan
@since	引入版本或日期	@since 1.8
@see	参考其他类/方法	@see java.util.ArrayList
{@code}	以代码字体显示内容	{@code int count = 0;}

演示：

/**
 * @author 大眼神龙
 * @since  2025.5.1
 * @version  1.1
 * {@code int count=0;}
 */
public class DocComment{
	/**
	 * main函数，程序入口
	 * @param args 参数
	 * @return 空，没有返回值
	 */
	public static void main(String[] args){
		System.out.println("Hello,World!");
	}
}

在cmd执行以下命令：

javadoc -d ./doc DocComment.java

会在当前目录下创建/doc目录，根据DocComment.java文件内容生成对应的文档，生成结果如下：

点击index.html打开网页，发现没有显示作者信息，默认情况下以下标签会被忽略：

标签	忽略条件	启用选项
@author	未使用-author选项时	-author
@version	未使用-version选项时	-version
@serial	未显式启用序列化文档生成时	需配合-serialwarn
@serialData	同@serial	同@serial
@serialField	同@serial	同@serial
@deprecated	始终生成，但需配合@deprecated注解	无（自动关联）

以及访问权限被限制时：private或包级私有成员的注释（包括所有标签）默认被忽略，需通过-private或-package选项启用

非法使用的标签和非标准标签也会被忽略。

使用javadoc -author -version -d ./doc DocComment.java命令重新生成文档，发现版本和作者信息显示出来。