Java 文档注释属性详解
2017-05-23 10:27
253 查看
Java 文档注释
Java只是三种注释方式。前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束。说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息,并输出到HTML文件中。
说明注释,是你更加方面的记录你的程序的信息。
javadoc 标签
javadoc工具软件识别以下标签:标签 | 描述 | 示例 |
---|---|---|
@author | 标识一个类的作者 | @author description |
@deprecated | 指名一个过期的类或成员 | @deprecated description |
{@docRoot} | 指明当前文档根目录的路径 | Directory Path |
@exception | 标志一个类抛出的异常 | @exception exception-name explanation |
{@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
{@link} | 插入一个到另一个主题的链接 | {@link name text} |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
@param | 说明一个方法的参数 | @param parameter-name explanation |
@return | 说明返回值类型 | @return explanation |
@see | 指定一个到另一个主题的链接 | @see anchor |
@serial | 说明一个序列化属性 | @serial description |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
@serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
@since | 标记当引入一个特定的变化时 | @since release |
@throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
{@value} | 显示常量的值,该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
@version | 指定类的版本 | @version info |
文档注释
在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述.之后,你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
多个相同类型的标签应该放成一组。例如,如果你有三个@see标签,可以将它们一个接一个的放在一起。
相关文章推荐
- Java注释详解-Java文档注释生成Java API文档
- Java注释详解-Java文档注释生成Java API文档
- JAVA 文档注释
- Java经验点滴:类注释文档编写方法
- 第1章 Java基本概念及环境配置——FAQ1.16 如何将程序中的文档注释提取出来生成说明文档?
- JAVA 文档注释--JAVADOC文档
- 如何将java程序中的文档注释提取出来生成说明文档
- JAVA 文档注释
- Eclipse/MyEclipse Java注释模板设置详解
- Eclipse Java注释模板设置详解
- java注释详解
- Eclipse Java注释模板设置详解
- 在java源码中为Javadoc编写文档注释(1)
- Doxygen 文档注释详解
- javadoc - Java API 文档生成器详解 转贴
- Eclipse Java注释模板设置详解
- JAVA 文档注释--JAVADOC文档
- 从Java源文件中批量榨取注释到设计文档
- java文档注释(有示例)
- Eclipse Java注释模板设置详解