在Java中,文档注释有哪些常用的标签?

在Java中,文档注释有哪些常用的标签? Java文档注释常用标签大全一、基础通用标签类、方法、变量都能用author作用标注代码作者示例author ZhangSanversion作用标注当前类/接口版本号示例version 1.0 2026-06since作用标注该功能从哪个JDK/项目版本开始提供示例since JDK 21see作用参考其他类、方法、网址生成跳转链接写法see User引用类see #getName()引用本类方法see a hrefxxx文档地址/adeprecated作用标记该类/方法已废弃不推荐使用搭配替代方案示例deprecated 请使用addNew()替代二、方法专属标签只能写在方法上param作用描述方法参数含义格式param 参数名 说明示例param age 用户年龄必须大于0return作用描述方法返回值含义无返回值void方法不能用示例return 返回计算后的总和throws / exception两者作用完全一致描述方法主动抛出的异常格式throws 异常类名 抛出场景示例throws IllegalArgumentException 年龄小于0时抛出三、约束说明标签serial作用标注序列化字段说明用于实现Serializable的类成员变量serialField作用描述序列化持久字段serialData作用writeObject自定义序列化的数据说明四、拓展说明标签IDE识别规范项目常用paramRef复杂参数引用说明link内联链接嵌入文字中间跳转示例{link User#login()}linkplain和link功能一样链接文字不加粗code包裹代码片段格式化展示代码{code int num 10;}literal原样输出文本不解析HTML符号五、完整使用示例/** * 用户操作工具类 * author LiSi * version 2.1 * since JDK 17 * see User * deprecated 新版推荐UserUtil2 */publicclassUserUtil{/** * 用户登录校验 * param username 账号名称 * param pwd 登录密码 * return 登录成功返回true失败false * throws NullPointerException 账号密码为空抛出 */publicbooleanlogin(Stringusername,Stringpwd){if(usernamenull)thrownewNullPointerException();returntrue;}}六、使用注意void返回值方法不能写returnparam、throws必须对应真实参数、异常类不能乱写标签区分书写顺序无强制要求行业规范顺序author→version→since→param→return→throws→see→deprecated。