java文档注释规范
2016-11-27 00:00
148 查看
摘要: java文档注释
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@ author 标明开发该类模块的作者
@ version 标明该类模块的版本
@ see 参考转向,也就是相关主题
@ param 对方法中某参数的说明
@ return 对方法返回值的说明
@ exception 对方法可能抛出的异常进行说明
-------------------------------------------------------------------------------------------------------------
@ author 作者名
@ version 版本号
其中,@ author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@ version 也可以使用多次,只有第一次有效
-------------------------------------------------------------------------------------------------------------
使用 @param、@ return 和 @ exception 说明方法
这三个标记都是只用于方法的。
@ param 描述方法的参数,
@ return 描述方法的返回值,
@ exception 描述方法可能抛出的异常。
它们的句法如下:
@ param 参数名参数说明
@ return 返回值说明
@ exception 异常类名说明
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@ author 标明开发该类模块的作者
@ version 标明该类模块的版本
@ see 参考转向,也就是相关主题
@ param 对方法中某参数的说明
@ return 对方法返回值的说明
@ exception 对方法可能抛出的异常进行说明
-------------------------------------------------------------------------------------------------------------
@ author 作者名
@ version 版本号
其中,@ author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@ version 也可以使用多次,只有第一次有效
-------------------------------------------------------------------------------------------------------------
使用 @param、@ return 和 @ exception 说明方法
这三个标记都是只用于方法的。
@ param 描述方法的参数,
@ return 描述方法的返回值,
@ exception 描述方法可能抛出的异常。
它们的句法如下:
@ param 参数名参数说明
@ return 返回值说明
@ exception 异常类名说明
相关文章推荐
- java基础第一讲——JDK、注释、帮助文档、编码规范
- JAVA 文档注释
- Java经验点滴:类注释文档编写方法
- java 规范(命名、注释 、Java 文件样式)
- Java的注释规范
- Java注释规范[转载]
- JAVA 文档注释
- Java文档注释说明
- java文档注释 编写格式
- JAVA注释文档
- java编码规范_缩进和注释
- 在java源码中为Javadoc编写文档注释(1)
- 从Java源文件中批量榨取注释到设计文档
- java学习笔记(四)----对象、数组作为参数传递,静态变量、静态方法的使用,内部类,使用文档注释
- Java的注释规范整理
- java文档注释
- JAVA 文档注释--JAVADOC文档
- Java 文档&注释 -Java学习笔记(32)
- java 注释规范
- Java注释规范