所有javadoc命令都只能出现于“/**”注释中。但和平常一样，注释结束于一个“*/”。主要通过两种方式来使用javADOc：嵌入的html，或使用“文档标记”。其中，“文档标记”(Doc tags)是一些以“@”开头的命令，置于注释行的起始处(但前导的“*”会被忽略)。

有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说，一个类注释正好位于一个类定义之前;变量注释正好位于变量定义之前;而一个方法定义正好位于一个方法定义的前面。如下面这个简单的例子所示：

/** 一个类注释 */

public class docTest {

/** 一个变量注释 */

public int i;

/** 一个方法注释 */

public void f() {}

}

注意javadoc只能为public(公共)和protected(受保护)成员处理注释文档。“private”(私有)和“友好”(详见5章)成员的注释会被忽略，我们看不到任何输出(也可以用-private标记包括private成员)。这样做是有道理的，因为只有public和protected成员才可在文件之外使用，这是客户程序员的希望。然而，所有类注释都会包含到输出结果里。

上述代码的输出是一个HTML文件，它与其他Java文档具有相同的标准格式。因此，用户会非常熟悉这种格式，可在您设计的类中方便地“漫游”。设计程序时，请务必考虑输入上述代码，用javadoc处理一下，观看最终HTML文件的效果如何。

Java里有两种类型的注释。第一种是传统的、C语言风格的注释，是从C++继承而来的。这些注释用一个“/*”起头，随后是注释内容，并可跨越多行，最后用一个“*/”结束。注意许多程序员在连续注释内容的每一行都用一个“*”开头，所以经常能看到象下面这样的内容：

/* 这是

* 一段注释，

* 它跨越了多个行

*/

但请记住，进行编译时，/*和*/之间的所有东西都会被忽略，所以上述注释与下面这段注释并没有什么不同：

/* 这是一段注释，

它跨越了多个行 */

第二种类型的注释也起源于C++。这种注释叫作“单行注释”，以一个“//”起头，表示这一行的所有内容都是注释。这种类型的注释更常用，因为它书写时更方便。没有必要在键盘上寻找“/”，再寻找“*”(只需按同样的键两次)，而且不必在注释结尾时加一个结束标记。下面便是这类注释的一个例子：

// 这是一条单行注释

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

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

展开全部

Ctrl+Shift+/ 。

拓展资料：

Java快捷键：

1. 【ALT+/】

此快捷键为用户编辑的好帮手32313133353236313431303231363533e58685e5aeb931333365653266，能为用户提供内容的辅助，不要为记不全方法和属性名称犯愁，当记不全类、方法和属性的名字时，多体验一下【ALT+/】快捷键带来的好处吧。

2. 【Ctrl+O】

显示类中方法和属性的大纲，能快速定位类的方法和属性，在查找Bug时非常有用。

3. 【Ctrl+/】

快速添加注释，能为光标所在行或所选定行快速添加注释或取消注释，在调试的时候可能总会需要注释一些东西或取消注释，现在好了，不需要每行进行重复的注释。

4. 【Ctrl+D】

删除当前行，这也是笔者的最爱之一，不用为删除一行而按那么多次的删除键。

5. 【Ctrl+M】

窗口最大化和还原，用户在窗口中进行操作时，总会觉得当前窗口小(尤其在编写代码时)，现在好了，试试【Ctrl+M】快捷键。

6. 【Ctrl+Shift+F】

格式化代码，书写格式规范的代码是每一个程序员的必修之课，当看见某段代码极不顺眼时，选定后按【Ctrl+Shift+F】快捷键可以格式化这段代码，如果不选定代码则默认格式化当前文件(Java文件)。

7. 【ALT+Shift+W】

查找当前文件所在项目中的路径，可以快速定位浏览器视图的位置，如果想查找某个文件所在的包时，此快捷键非常有用(特别在比较大的项目中)。

8. 【Ctrl+L】

定位到当前编辑器的某一行，对非Java文件也有效。

9. 【Alt+←】、【Alt+→】

后退历史记录和前进历史记录，在跟踪代码时非常有用，用户可能查找了几个有关联的地方，但可能记不清楚了，可以通过这两个快捷键定位查找的顺序。

10. 【F3】

快速定位光标位置的某个类、方法和属性。

11. 【F4】

显示类的继承关系，并打开类继承视图。