关于如何生成Java文档

一.生成Java文档，要明白Java注释内容，若是不知道，能够去看上一篇文章。

二.Java系统提供的javadoc工具能够根据程序结构自动生成注释文档。当程序修改时可方便及时更新生成的注释文档。javadoc.exe工具存在于JDK的bin目录下，使用javadoc将读取.java源文件中的文档注释，并按照必定的规则与Java源程序一块儿进行编译，生成文档。

三.javadoc经常使用标记：

（上面截图来自javadoc的百度百科，读者也能够本身去百度百科看），除了这些，还有一些不经常使用的标记，这里就不列举了。

四.javadoc命令的通常形式：

javadoc [options] [packages] [sourcefiles] [@files]

在命令中有4组可选项，方括号自己不是命令的一部分。命令行的每一个选项之间用一个或多个空格分开。各组选项的用途：

①options，指定执行javadoc时的命令选项，若是想显示标准命令选项，可使用以下命令：javadoc -help

②packages，须要处理的一系列包名，名字之间用一个或多个空格分开

③sourcefiles，一系列用空格分隔的源文件名，可使用通配符，若是想指定当前目录的全部源文件，可使用*.java表示

④@files，用空格分隔的一个或多个源文件的名字，也能够是一个或多个包，每一个文件必须用@作为前缀符

五.Javadoc中options选项不少，下面列出了经常使用的选项：

①-author，生成@author标记

②-version，生成@version标记

③-package，把文档输出到包、公有的或受保护的类和成员上

④-public，把文档输出到公有类和成员上

⑤-protected，把文档输出到公有类和受保护的类以及公有的类成员上

⑥-private，把全部类和成员生成文档注释

⑦-d directoryName，使javadoc生成的HTML文件存储在指定的目录下。默认为当前目录

六.示例

Java代码：

 

注意：

①这个类必定要使用public修饰，这表示对外开放的，这样javadoc才能从中提取出注释文档；

②类中的方法（包括构造）若是使用private修饰，即本类中的内部调用类，则在生成的注释文档中不会显示这个方法，由于private表明它不对外开放。

在命令提示符下操做（先进入源程序目录）：

①javadoc -d myhelp -author -version ArrayTool.java

（这里myhelp是指生成的帮助文档将放在源目录的myhelp子目录下面，这个目录也能够本身设置，只要是完整的路径就能够，若是写了本地磁盘上没有的文件夹，则myhelp文件夹将自动生成）