荣新教育:坚持面授的良心机构
全国咨询热线:400-1335-066
您现在的位置:首页>行业新闻 > 正文

Java文档注释

时间:2018-07-12 17:54:23 来源:荣新IT教育培训 作者:荣新科技
今天事情比较多,就不多说啥了,荣新教育今天给大家分享的是一些java的基础知识,文档注释的知识,一起来看看吧。
Java文档注释
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
文章源自荣新教育官网:www.vfast.com.cn欢迎访问,转载需注明出处