5.14 Java文档注释（？）

Java支持三种形式的注释。前俩种是//和/*...*/。

第三种方式被称为文档注释。它以”/**“ 开始，以”*/“标志结束。

文档注释提供将程序信息嵌入到程序中的功能。

开发者可以使用javadoc工具将信息取出，然后转换为HTML文件。

文档注释提供了编写程序文档的便利方式。

javadoc程序识别下列标记：

正如上面看到的那样，所有的文档标记都以”@“标志开始。在一个文档注释中，也可以使用其他的标准HTML标记。

然而，一些标记（如标题）是不能使用的。因为他们会破坏由javadoc生成的HTML文件外观。

可以使用文档注释为类，接口，域，构造方法和方法提供文档。

在所有这些情况中，文档注释必须紧接在被注释的项目之前。

为变量做注释可以使用@see，@since，@serial，@serialField，和@deprecated文档标记。

为类做注释可以使用@see，@autor，@since，@deprecated，@throws，@serialData，@exception文档标记。

而 {@link} 或 {@docRoot}标记可以使用在任何地方。

javadoc的输出

javadoc程序将java程序的源文件作为输入，输出几个包含该程序文档的HTML文件。

每个类的信息都在其自己的HTML文件中，同时，javadoc还输出一个索引和一个层次结构树。

javadoc还可生成其他的HTML文件。

待续。。。。