帮助文档(API)--制作帮助文档（API）

制作帮助文档（API）

文档注释：

格式：/** ... */

如何通过文档注释制作一个说明书呢？

• 写一个工具类
• 在工具类中加入文档注释

怎么加？

请看ArrayTool中的文档注释

加什么东西呢？

作者，版本，方法中参数，返回值等等

• 怎么用呢？

在DOS命令行窗口输入

javadoc -d 目录 -author -version ArrayTool.java

如果在当前目录使用该命令，当前目录可以用 . 表示

ArrayTool.java--是工具类的文件名

如果运行出错看一下是不是ArrayTool.java的编码格式有问题

有问题的话，通过另存为改编码格式为ANSI

 

• 运行之后

当前文件夹里会多出来很多东西

找到  index.html 双击运行

就可以看到自己制作的API了