Javadoc 注释标签语法

最新推荐文章于 2025-06-30 19:02:33 发布
最新推荐文章于 2025-06-30 19:02:33 发布
阅读量977 收藏
点赞数
CC 4.0 BY-SA版权
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Stitch__/article/details/80156460
本文详细介绍了Java中各类注释的使用规范，包括作者、版本、参数、返回值及异常说明等，帮助开发者更好地理解和应用这些注释，提高代码的可读性和维护性。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

//注释的标签

@author  对类的说明--标明开发该类模块的作者

@version  对类的说明--标明该类模块的版本

@param    对方法的说明--方法中某参数的说明

@return  对方法的说明--方法返回值的说明

@exception  对方法的说明--方法可能抛出的异常的说明

java中Javadoc文档注释标签使用详解
记录学习的过程
05-14 781
本文全面介绍了Javadoc注释的使用方法，涵盖了基础语法、核心标签、内联标签、完整注释示例以及生成文档的步骤。Javadoc通过特定的注释标签（如@param、@return、@throws等）生成规范的API文档，帮助开发者更好地理解和使用代码。文章还提供了最佳实践和高级技巧，如继承父类文档、包级别文档和自定义标签的使用。通过规范使用Javadoc，可以提高代码的可维护性和团队协作效率，生成专业且实用的API文档。
JavaDoc【注释】生成API（开发文档）详解
kertnudserf56968的博客
02-13 2348
Javadoc 是 Java 自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
Javadoc注释标签语法
必应@珠峰
10-05 882
javadoc可以根据项目代码的注释（当然是规范化的）自动生成HTML格式的API文档。三种注释类型（注释必须紧贴着注释体，不然javadoc会忽略）：类注释变量注释方法注释 书写格式：/**  * ........ * @XXX  */ 参数说明：@see 生成文档中的“参见xx 的条目”的超链接，后边可以加上：“类名”、“完整类名”、“完整类名#方法”。可用于：类、方法、变
javadoc注释标签语法
hhkiss1的专栏
01-10 755
本文为大家讲解的是javadoc注释标签的语法，感兴趣的同学参考下。 @author 对类的说明 标明开发该类模块的作者 @version 对类的说明 标明该类模块的版本 @see 对类、属性、方法的说明 参考转向，也就是相关主题 @param 对方法的说明 对方法中某参数的说明 @return 对方法的说明 对方法返回值的说明 @exception 对方法的说明 对方法可能抛出的
Java基础篇之注释详解
最新发布
ILoveYou_Xuxu的博客
06-30 561
你有没有遇到过如下的问题呢？1、一个你从来没有参与过的10年前开发的项目，客户对原来的功能要做调整，拿到代码一看：卧槽，这咋没有注释？这个变量是什么东西？这个方法是干啥用的？这段代码的处理逻辑咋这么长，都干了啥？2、2年前，你负责开发的一个系统中的重要功能模块，业务逻辑随着业务数据的调整，需要对代码进行版本迭代，你重新找到了这部分代码，本来信心满满(都是我自己写的，妥妥没问题，很快就能完事)，但是一看代码：额……这个变量当时咋设计的来着？这个方法的逻辑一共xx个步骤，咋想不起来每一步具体都是干啥的了？
JavaDoc命令使用说明
lucy_lin的专栏
07-20 833
javadoc的命令行语法如下：javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明：" Packagenames 包列表。这个选项可以是一系列的包名（用空格隔开），例如java.lang java.lang.reflect java.awt。不过，因为ja
java 注释标签_JAVA文档注释标签
weixin_30359591的博客
02-12 364
1常用Java注释标签(Java comment tags)@author作者@param输入参数的名称说明@return输出参数说明@since JDK版本@version版本号@see链接目标@throws异常@deprecated解释@link链接地址2 Java注释的使用顺序3简单常见的HTML嵌入4HTML嵌入注释范例5参考文档1常用Java注释标签...
行上注释转javadoc注释正则表达式
10-10
将这样的行上注释转换为Javadoc风格（JavaDoc注释）的格式，需要识别出单行或多行注释的开始和结束，并保持文档结构。一种简单的正则表达式可能无法完全覆盖所有情况，但可以尝试匹配常见的模式。以下是一个基础的...
JAVA Review-IDE中设置作者日期等Javadoc注释信息
Dusty丶one的博客
06-03 3103
在Java的IDE（Integrated Development Environment,集成开发环境）中，如Eclipse、Spring Tool Suite、IntelliJ IDEA等，都可以设置自动添加的Javadoc注释信息，可以添加@author 作者名、@version 版本标识、@date 日期等，新添加类或方法时会自动添加注释信息，很方便。/*被注释语句/ 就是专为Javadoc...
java注释-javadoc规范
逍遥云中鸟
01-22 648
写在前面：javadoc内嵌于JDK中，那么遵循javadoc规范自然就是java注释的正统，有javadoc帮忙生成API文档，简直不要太幸福。此文章在逐步完善中，我对于此规范也在学习中，希望能够掌握，也希望文章对你有所帮助。 1.什么是注释 注释是为了使代码更具有可读性，降低团队合作的交流成本。在一个团队中，你的代码更清晰、更易读，更规范，那么升职加薪肯定是你的，因为你可以兼容更多的人。 前段时间听到一个说法：你的代码写的只有你一个人看得懂，那你就是那个不可或缺的人。说这话的人就是脑残，写的代码只有自己
常用Java注释标签
tmj2014的专栏
10-11 6700
1   常用Java注释标签（Java comment tags） @author  作者适用范围：文件、类、方法 （*多个作者使用多个@author标签标识，java doc中显示按输入时间顺序罗列。） 例：* @author Leo. Yao @param  输入参数的名称  说明 适用范围：方法 例：* @param str the String用来存放输出信息。 @re
JAVA文档注释小结
colbybobo的博客
08-21 482
1 常用Java注释标签（Java comment tags） @author  作者 @param  输入参数的名称  说明 @return 输出参数说明 @since JDK版本 @version 版本号 @see 链接目标 @throws 异常 @deprecated 解释 @link 链接地址 2 Java注释的使用顺序 3 简单常见的HTML嵌入 4 HT...
Javadoc的注释方式
m0_73837751的博客
11-24 1473
***/@标签描述方法的参数。描述方法的返回值。描述方法可能抛出的异常。提供相关链接，用于引用类、方法或文档。标记方法或类已废弃，建议开发者避免使用。表示从哪个版本开始引入。@since 版本号嵌入式链接，用于引用类或方法。标注类或接口的作者。标注类的版本号。用于嵌入代码片段，常用于描述参数或示例。
浅聊Java注释标签
thinking_3的博客
10-08 337
Java注释标签可以提高代码规范，增加代码的可读性，常用的Java注释标签都有什么呢，我们一起来学习下。 1.@see，此标签允许用户引用其他类的文档，javadoc会在其生成的HTML文件中，通过@see标签连接到其他文档。 2.@version，顾名思义版本信息，此标签可以标明你的版本号，版本中需说明的信息等内容。 3.@author，作者信息，可以留下你的名字，联系方式。 4.@...
java注解（java内容的标签）
快乐学习
10-11 1431
一、概念解释 1.什么是注解？ 标准解释：java中的类、构造器、方法、成员变量、参数都可以被注解进行贴上标签。 直白理解：注解也可以理解为标签。对一个人的评价高矮胖瘦，好人坏人或者渣男老实人等，就是起到你给它贴上这个标签，但是这些标签又不会对他本人产生什么影响。因为那个标签只是你的看法 2.注解有什么作用？ 答：就是为了方便对类中的信息进行标注注释，方便查看。不会对实际代码产生什么影响。 3.注解的学习内容分类？ 1.自定义注解 2.元注解 3.注解的解析
JavaDoc注释规范与指南
文档注释的内容遵循 HTML 语法，支持 HTML 标签，并提供一些专用于 Javadoc 的辅助标记，如 `@param`, `@return`, `@throws`, `@since`, `@author`, `@version` 等。尽管这些标记可能看起来复杂且不易阅读，但它们...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值