注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。

Java支持以下三种注释方式：

1)单行注释

以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。打开 Eclipse，在 Java 代码中使用单行注释，如图 1 所示。

图 1 单行注释

2)多行注释

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息(这样也比较美观好看)，如图 2 所示。

注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。

图 2 多行注释

3)文档注释

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容，如图 3 所示。

注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。

图 3  文档注释

文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档，并输出到 HTML 文件中，方便记录程序信息。还可以包含一个或多个 @ 标签，每个 @ 标签都在新的一行开始。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

在 Java 中，一行注释以双斜杠“//”标识；多行注释包含在“/*”和“*/”之间；文档注释包含在“/**”和“*/”之间。当编译器执行到“//”时，就会忽略该行“//”之后的所有文本；当执行到“/*”时，会扫描下一个“*/”并忽略“/*”和“*/”之间的任何文本；当执行到“/**”时，也会扫描下一个“*/”并忽略“/**”和“*/”之间的任何文本内容。

本文来自投稿，不代表访得立场，如若转载，请注明出处：http://www.found5.com//view/1179.html