文档注释
JDK包含一个很有用的工具，javadoc，可以由源文件生成一个html文档，官方的api文档就是通过对标准java类库的源代码运行javadoc生成的
文档的注解通常以定界符/**开始注解
通常javadoc实用程序从下面这几个特性中抽取信息
- 包
- 公有类与接口
- 公有的和受保护的构造器及方法
- 公有的和受保护的域
应该为上面几个部分编写注解
文档标记表现为/ ** …./,/**这个是开头,后面*/这个是结尾，中间就是自由格式文本，标记由@开头，自由格式文本第一句应该是一个概要性的句子，在自由格式文本中可以使用html修饰符，如<em>…,<strong>…以及包含图像的等，一定不要使用
.
因为它们会与文档格式产生冲突，若要键入等宽代码，需要使用{@code…},而不是<code>…<\code>
类注解
类注解必须放在import语句之后，类定义之前
方法注解
每个方法注解必须放在所描述的方法之前，除了通用标记之后，还可以使用以下标记
@param变量描述，这个描述可以占多行，一个方法的所有@param标记必须放在一起
@return描述，可以标记将对当前方法返回的部分进行描述
@throws类描述，描述这个方法可能抛出的异常
域注解
只需要对公有域（通常指的是静态常量）建立说明文档
通用注解
顾名思义据是哪都可以注，如下标记
@author姓名
@version文本，版本，对当前版本的任何描述
@since文本，是对引入特性的版本描述，
@deprecated文本，这个标记表示类，方法，或变量将不再被使用的意思
@see引用，这个标记将在see alse部分增加一个超级链接
包与概述注解
如果想为包注解，就需需要在每个包目录加一个单独的文件。可以有两种选择
1 ) 提供一个以 package.html 命名的 HTML 文件。在标记 <body>…之间的所有 文本都会被抽取出来。
2 ) 提供一个以 package-info.java 命名的 Java 文件。这个文件必须包含一个初始的以 /** 和 */ 界定的 Javadoc 注释， 跟随在一个包语句之后。它不应该包含更多的代码或注释。
还可以为所有的源文件提供一个概述性的注释。这个注释将被放置在一个名为 overview, html 的文件中，这个文件位于包含所有源文件的父目录中。标记<body>…之间的所 有文本将被抽取出来。当用户从导航栏中选择“ Overview” 时，就会显示出这些注释内容。
注解的抽取
注释的抽取 这里，假设 HTML 文件将被存放在目录 docDirectory 下。执行以下步骤： 1 ) 切换到包含想要生成文档的源文件目录。 如果有嵌套的包要生成文档， 例如 com. horstmann.corejava, 就必须切换到包含子目录 com 的目录（如果存在 overview.html 文件的 话， 这也是它的所在目录)
2 ) 如果是一个包，应该运行命令:
javadoc -d docDirectory nameOfPackage
或对于多个包生成文档，运行:
javadoc -d docDirectory nameOfPackage\ nameOfPackage . . .
如果文件在默认包中， 就应该运行：
javadoc -d docDirectory *.java
另一个很有用的选项是 -link, 用来为标准类添加超链接。例如， 如果使用命令 javadoc -link http://docs.oracle.eom/:javase/14/docs/api *.java 那么，所有的标准类库类都会自动地链接到 Oracle 网站的文档。