如何使用javadoc注释中的标记
2017-08-12 10:31
351 查看
javadoc标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc标记有如下一些:
@auther标记开发该类模块的作者
@version:标明该类模块的版本
@see:参考转向,也就是相关主题
@param: 对方法中某参数的说明
@return: 对方法返回值的说明
@execption:对方法可能抛出的异常进行说明
@author:作者名
@version: 版本号
其中,@author可以多次使用,以指明多个作者之间使用<,>隔开.
@version也可以多次使用,只有一次有效使用@param,@return,@exception说明方法
这三个标记都只用于方法,@param描述方法的参数,@return描述方法的返回值,@exception描述可能抛出的异常值
@param参数名 参数说明
@return 返回值说明
@exception 异常类名 说明
javadoc标记有如下一些:
@auther标记开发该类模块的作者
@version:标明该类模块的版本
@see:参考转向,也就是相关主题
@param: 对方法中某参数的说明
@return: 对方法返回值的说明
@execption:对方法可能抛出的异常进行说明
@author:作者名
@version: 版本号
其中,@author可以多次使用,以指明多个作者之间使用<,>隔开.
@version也可以多次使用,只有一次有效使用@param,@return,@exception说明方法
这三个标记都只用于方法,@param描述方法的参数,@return描述方法的返回值,@exception描述可能抛出的异常值
@param参数名 参数说明
@return 返回值说明
@exception 异常类名 说明
相关文章推荐
- javadoc中文档注释标记的使用
- HTML标记【加注释标记和nobr的使用】!
- 如何使用跟踪标记 1204
- 如何使用跟踪标记 1204
- 如何使用跟踪标记 1204
- 如何使用跟踪标记 1204
- [摘选]如何使用注释文档和提取?
- JavaDoc使用注释
- 使用注释标记对屏蔽JavaScript代码
- 如何使用跟踪标记 1204
- 如何使用跟踪标记 1204
- JPA中各注释标记的含义及使用方法
- 使用eclipse生成html格式注释文档 [ javadoc ]
- 如何使用跟踪标记 1204
- 如何使用PHP来快速将纯ASCII文本完美地转换成为可读的HTML标记
- 如何使用跟踪标记 1204
- JavaDoc注释使用
- 如何使用后台代码在head标记中动态生成javascript?
- PowerDesigner的创建使用及如何设置显示注释信息
- 如何使用 Java 5 的内置注释