Java平台最“体贴”的工具

在软件项目管理过程中，如何保证程序代码与软件技术文档一致可以说是最麻烦的事情。无论是先修改代码还是先修改文档，各种记录的管理都是一件麻烦事。而且很难保证两种变化的一致性和实时性。可喜的是，Java平台的设计者们已经充分考虑到了这一点，他们非常体贴的为Java开发者带来了一个文档管理工具——javadoc。

Javadoc使用Java编译器javac解析程序代码源文件中的声明和文档注释，默认生成一组HTML文档来描述类、内部类、接口、构造函数、方法和域。但是在运行过程中，它也使用Java平台的环境变量classpath来确定类的搜索路径。当涉及到类和内部类的描述时，classpath变量设置是否正确可能会影响javadoc命令是否能够完全成功执行。

javadoc生成的默认文件列表如下:

基本页面文件:

calssname.html类或接口描述文件，一个文件对应一个类或接口。

Package-summary.html汇总文件，一个文件对应一个包。

overview-summary.html总概要文件

交叉引用页面文件:

overview-tree.html所有薪资包的类别层次结构页面

package-tree.html包的“分类层次结构”页面

Package-use.html包使用页面

class-use \ class name . html类用法页面

deprecated-list.html不鼓励的方法

Serialized-form.html序列化页面

索引-*。html索引文件

支持文件:

Help-doc.html帮助文件

index.html指南页面是整个文档的入口。

*-frame.html框架文件

Stylesheet.css样式表文件

Doc-files目录存储一些与HTML相关的杂项文件。如图片文件等。

javadoc的命令行语法如下:

javadoc [选项] [包名] [源文件][@文件]

参数可以任意顺序排列。这些参数和一些相关内容解释如下:

Packagenames包列表。该选项可以是一系列包名(用空)分隔，如Java . lang Java . lang . reflect
Java . awt .但是，由于javadoc不递归作用于子包，包名不允许使用通配符；因此，您必须明确列出您想要创建文档的每个包。

源文件源文件列表。该选项可以是一系列源文件名(用空分隔)，并且可以使用通配符。Javadoc允许四种源文件:类源代码文件、包描述文件、通用概述文件和其他杂项文件。

◇类源代码文件:类或接口的源代码文件。

◇包描述文件:每个包都可以有自己的包描述文件。包描述文件的名称必须是“package.html”，它与包的放在一起。java文件。描述文件的内容通常是用HTML标记编写的文档。Javadoc在执行时会自动找到包描述文件。如果找到，javadoc会先处理描述文件之间的内容，然后将处理结果放入包的包
摘要页面，最后将包描述文件的第一句话(旁边)放入输出概述摘要页面，并在语句前面加上包的包名。

◇通用概要文件:javadoc可以创建一个通用概要文件来描述整个应用程序或所有包。概览文件可以任意命名或放在任何地方。-overview选项可以指示整个概述文件的路径和名称。概述文件的内容是用HTML标记编写的文档。Java在执行的时候，如果找到-overview选项，会先处理文件之间的内容；然后将处理后的结果放在输出概述
摘要页面的底部；最后，将一般概述文件中的第一句话放在输出概述摘要页面的顶部。

◇其他杂项文件:这些文件通常指一些图片文件，Java源代码文件(。java)、Java程序(。类)、Java小程序和与javadoc输出的HTML文件相关的HTML文件。这些文件必须放在doc-files目录中。每个包可以有自己的doc-files目录。比如你想在java.awt.Button的HTML文档中使用一个按钮(Button.gif)的图片首先你必须把图片文件放在C:\ user \ src \ Java \ awt \ doc-files \中；然后将以下注释添加到Button.java文件中