java抽取注释_4.9.7 注释的抽取

这里，假设HTML文件将被存放在目录docDirectory下。执行以下步骤：

1)切换到包含想要生成文档的源文件目录。如果有嵌套的包要生成文档，例如com.horstmann.corejava，就必须切换到包含子目录com的目录(如果存在overview.html文件的话，这也是它的所在目录)。

2)如果是一个包，应该运行命令：

javadoc -d docDiredtory nameOfPackage

或对于多个包生成文档，运行：

javadoc -d docDirectory nameOfPackage1 nameOfPackage2...

如果文件在默认包中，就应该运行：

javadoc -d docDirectory *.java

如果省略了-d docDirectory选项，那HTML文件就会被提取到当前目录下。这样有可能会带来混乱，因此不提倡这种做法。

可以使用多种形式的命令行选项对javadoc程序进行调整。例如，可以使用-author和-version选项在文档中包含@author和@version标记(默认情况下，这些标记会被省略)。另一个很有用的选项是-link，用来为标准类添加超链接。例如，如果使用命令

javadoc -link http://java.sun.com/javase/6/docs/api *.java

那么，所有的标准类库类都会自动地链接到Sun网站的文档。

如果使用-linksource选项，则每个源文件被转换为HTML(没有颜色编码，但包含行编号)并且每个类和方法名将转变为指向源代码的超链接。

有关其他的选项，请查阅javadoc实用程序的联机文档，http://java.sun.com/javase/javadoc。

注释：如果需要进一步的制定，例如，生成非HTML格式的文档，可以提供自定义的doclet，以便生成想要的任何输出形式。显然，这是一种特殊的需求，有关细节内容请查阅http://java.sun.com/j2se/javadoc的联机文档。

提示：DocCheck是一个很有用的doclet，在http://java.sun.com/j2se/javadoc/doccheck/上。它可以为遗漏的文档注释搜索一组源程序文件。