帮助文档的制作javadoc

时间:2022-09-17 10:06:32

将自己写的工具类Tool的Tool.class文件发送给其他人,其他人只要将该文件设置到classpath路径下,就可以使用该工具类。

但是很遗憾,该类中到底定义了多少个方法,对方却不清楚,因为该类并没有使用说明书。

开始制作程序的说明书,Java的说明书通过文档注释来完成。

/**

.............

@ author joan

@ version v1.1

*/

/**

@ param arr 数组

@ return ............

*/

用类似这样的格式来给Java文件注释。

Javac -d myhelp -author -version javac Tool.java

1.需要bin目录下的javadoc.exe工具,对该文档进行提取并形成说明书。

2.这里我们把建好的Tool.java放到D盘的java目录下。

3.----->cmd----->javac----->D:------>cd java------>javac Tool.java

进入D盘的java目录下,编译Tool.class文件。

4.javadoc -d myhelp -author -version javac Tool.java

对该文档进去提取并形成说明书。

在D盘java目录下,生成文件名为myhelp的说明书,可以显示版本、作者。

-d  --->就是在dir路径

-dc  ---->也可以指定说明书生成的位置,例如,在C盘。

5.发给其他人用是,就只要有Tool.class和说明书就可以了,给Tool.class配置环境变量。