Attic

Java注释

Java  ·  

用于注解说明解释程序的文字，提高代码可读性；注释是一个程序员必须要具有的良好的编程习惯，将自己的思维通过注释先整理出来，再用代码去体现。

Java中的注释类型：

  1. 单行注释：//注释文字，快捷键：Ctrl + /；
  2. 多行注释：/* 注释文字 */，多行注释里不允许有多行注释嵌套，快捷键：Ctrl + Shift + /；
  3. 文档注释：注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的程序的说明文档，一般写在类。使用 javadoc： javadoc -d 文件夹名 -xx -yy Demo3.java
 javadoc -d 文件夹名 -xx -yy Demo3.java

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