mirror of
https://github.com/LingCoder/OnJava8.git
synced 2026-08-24 06:53:27 +08:00
209 lines
7.7 KiB
Markdown
209 lines
7.7 KiB
Markdown
[TOC]
|
||
|
||
<!-- Appendix: Javadoc -->
|
||
# 附录:文档注释
|
||
|
||
编写代码文档的最大问题可能是维护该文档。如果文档和代码是分开的，那么每次更改代码时更改文档都会变得很繁琐。解决方案似乎很简单：将代码链接到文档。最简单的方法是将所有内容放在同一个文件中。然而，要完成这完整的画面，您需要一个特殊的注释语法来标记文档，以及一个工具来将这些注释提取为有用的表单中。这就是Java所做的。
|
||
|
||
提取注释的工具称为Javadoc，它是 JDK 安装的一部分。它使用Java编译器中的一些技术来寻找特殊的注释标记。它不仅提取由这些标记所标记的信息，还提取与注释相邻的类名或方法名。通过这种方式，您就可以用最少的工作量来生成合适的程序文档。
|
||
|
||
Javadoc输出为一个html文件，您可以使用web浏览器查看它。对于Javadoc，您有一个简单的标准来创建文档，因此您可以期望所有Java libraries都有文档。
|
||
|
||
此外，您可以编写自己的Javadoc处理程序doclet，对于 Javadoc（例如，以不同的格式生成输出）。
|
||
|
||
以下是对Javadoc基础知识的介绍和概述。在 JDK 文档中可以找到完整的描述。
|
||
|
||
## 句法规则
|
||
|
||
所有Javadoc指令都发生在以 **/**** 开头(但仍然以 ***/** 结尾)的注释中。
|
||
|
||
使用Javadoc有两种主要方法:
|
||
|
||
嵌入HTML或使用“doc标签”。独立的doc标签是指令它以 **@** 开头，放在注释行的开头。(然而，前面的 ***** 将被忽略。)可能会出现内联doc标签
|
||
|
||
Javadoc注释中的任何位置，也可以，以一个 **@** 开头，但是被花括号包围。
|
||
|
||
有三种类型的注释文档，它们对应于注释前面的元素:类、字段或方法。也就是说，类注释出现在类定义之前，字段注释出现在字段定义之前，方法注释出现在方法定义之前。举个简单的例子:
|
||
|
||
```java
|
||
// javadoc/Documentation1.java
|
||
/** 一个类注释 */
|
||
public class Documentation1 {
|
||
/** 一个属性注释 */
|
||
public int i;
|
||
/** 一个方法注释 */
|
||
public void f() {}
|
||
}
|
||
|
||
```
|
||
|
||
Javadoc处理注释文档仅适用于 **公共** 和 **受保护** 的成员。
|
||
|
||
默认情况下，将忽略对 **私有成员** 和包访问成员的注释（请参阅["隐藏实现"](/docs/book/07-Implementation-Hiding.md)一章），并且您将看不到任何输出。
|
||
|
||
这是有道理的，因为仅客户端程序员的观点是，在文件外部可以使用 **公共成员** 和 **受保护成员** 。 您可以使用 **-private** 标志和包含 **私人** 成员。
|
||
|
||
要通过Javadoc处理前面的代码，命令是：
|
||
|
||
```cmd
|
||
javadoc Documentation1.java
|
||
```
|
||
|
||
这将产生一组HTML文件。 如果您在浏览器中打开index.html，您将看到结果与所有其他Java文档具有相同的标准格式，因此用户对这种格式很熟悉，并可以轻松地浏览你的类。
|
||
|
||
## 内嵌 HTML
|
||
|
||
Javadoc传递未修改的HTML代码，用以生成的HTML文档。这使你可以充分利用HTML。但是，这样做的主要目的是让你格式化代码，例如：
|
||
|
||
```java
|
||
// javadoc/Documentation2.java
|
||
/** <pre>
|
||
* System.out.println(new Date());
|
||
* </pre>
|
||
*/
|
||
public class Documentation2 {}
|
||
```
|
||
|
||
您你也可以像在其他任何Web文档中一样使用HTML来格式化说明中的文字：
|
||
|
||
```java
|
||
// javadoc/Documentation3.java
|
||
/** You can <em>even</em> insert a list:
|
||
* <ol>
|
||
* <li> Item one
|
||
* <li> Item two
|
||
* <li> Item three
|
||
* </ol>
|
||
*/
|
||
public class Documentation3 {}
|
||
```
|
||
|
||
请注意，在文档注释中，Javadoc删除了行首的星号以及前导空格。 Javadoc重新格式化了所有内容，使其符合标准文档的外观。不要将诸如 \<h1\>或 \<hr\>之类的标题用作嵌入式HTML，因为Javadoc会插入自己的标题，后插入的标题将对其生成的文档产生干扰。
|
||
|
||
所有类型的注释文档（类，字段和方法）都可以支持嵌入式HTML。
|
||
|
||
## 示例标签
|
||
|
||
以下是一些可用于代码文档的Javadoc标记。在尝试使用Javadoc进行任何认真的操作之前，请查阅JDK文档中的Javadoc参考，以了解使用Javadoc的所有不同方法。
|
||
|
||
### @see
|
||
|
||
这个标签可以将其他的类连接到文档中，Javadoc 将使用 @see 标记超链接到其他文档中，形式为：
|
||
|
||
```java
|
||
@see classname
|
||
@see fully-qualified-classname
|
||
@see fully-qualified-classname#method-name
|
||
```
|
||
|
||
每个都向生成的文档中添加超链接的“另请参阅”条目。 Javadoc 不会检查超链接的有效性。
|
||
|
||
### {@link package.class#member label}
|
||
|
||
和 @see 非常相似，不同之处在于它可以内联使用，并使用标签作为超链接文本，而不是“另请参阅”。
|
||
|
||
### {@docRoot}
|
||
|
||
生成文档根目录的相对路径。对于显式超链接到文档树中的页面很有用。
|
||
|
||
### {@inheritDoc}
|
||
|
||
将文档从此类的最近基类继承到当前文档注释中。
|
||
|
||
### @version
|
||
|
||
其形式为：
|
||
|
||
```java
|
||
@version version-information
|
||
```
|
||
|
||
其中 version-information 是你认为适合包含的任何重要信息。当在Javadoc命令行上放置 -version 标志时，特别在生成的HTML文档中用于生成version信息。
|
||
|
||
### @author
|
||
|
||
其形式为：
|
||
|
||
```
|
||
@author author-information
|
||
```
|
||
|
||
author-information 大概率是你的名字，但是一样可以包含你的 email 地址或者其他合适的信息。当在 Javadoc 命令行上放置 -author 标志的时候，在生成的HTML文档中特别注明了作者信息。
|
||
|
||
你可以对作者列表使用多个作者标签，但是必须连续放置它们。所有作者信息都集中在生成的HTML中的单个段落中。
|
||
|
||
### @since
|
||
|
||
此标记指示此代码的版本开始使用特定功能。例如，它出现在HTML Java文档中，以指示功能首次出现的JDK版本。
|
||
|
||
### @param
|
||
|
||
这将生成有关方法参数的文档：
|
||
|
||
```java
|
||
@param parameter-name description
|
||
```
|
||
|
||
其中parameter-name是方法参数列表中的标识符，description 是可以在后续行中继续的文本。当遇到新的文档标签时，说明被视为完成。@param 标签的可以任意使用，大概每个参数一个。
|
||
|
||
### @return
|
||
|
||
这记录了返回值：
|
||
|
||
```java
|
||
@return description
|
||
```
|
||
|
||
其中description给出了返回值的含义。它可延续到后面的行内。
|
||
|
||
### @throws
|
||
|
||
一个方法可以产生许多不同类型的异常，所有这些异常都需要描述。异常标记的形式为：
|
||
|
||
```java
|
||
@throws fully-qualified-class-name description
|
||
```
|
||
|
||
fully-qualified-class-name 给出明确的异常分类名称，并且 description （可延续到后面的行内）告诉你为什么这特定类型的异常会在方法调用后出现。
|
||
|
||
### @deprecated
|
||
|
||
这表示已被改进的功能取代的功能。deprecated 标记表明你不再使用此特定功能，因为将来有可能将其删除。标记为@不赞成使用的方法会导致编译器在使用时发出警告。在Java 5中，@deprecated Javadoc 标记已被 @Deprecated 注解取代（在[注解]()一章中进行了描述）。
|
||
|
||
## 文档示例
|
||
|
||
**objects/HelloDate.java** 是带有文档注释的例子。
|
||
|
||
```java
|
||
// javadoc/HelloDateDoc.java
|
||
import java.util.*;
|
||
/** The first On Java 8 example program.
|
||
* Displays a String and today's date.
|
||
* @author Bruce Eckel
|
||
* @author www.MindviewInc.com
|
||
* @version 5.0
|
||
*/
|
||
public class HelloDateDoc {
|
||
/** Entry point to class & application.
|
||
* @param args array of String arguments
|
||
* @throws exceptions No exceptions thrown
|
||
*/
|
||
public static void main(String[] args) {
|
||
System.out.println("Hello, it's: ");
|
||
System.out.println(new Date());
|
||
}
|
||
}
|
||
/* Output:
|
||
Hello, it's:
|
||
Tue May 09 06:07:27 MDT 2017
|
||
*/
|
||
```
|
||
|
||
你可以在Java标准库的源代码中找到许多Javadoc注释文档的示例。
|
||
|
||
|
||
|
||
<!-- 分页 -->
|
||
|
||
<div style="page-break-after: always;"></div>
|