java如何制作帮助文档_使用javadoc命令制作帮助文档（API）

测试代码如下：

1、生成帮助文档的方法：

①、打开DOS窗口；

②、定位到到该类的源文件所在文件夹；

③、输入命令：javadoc -d c:\help -author -version Test.java

对命令的说明：-d：其后空一格，用来指定生成的帮助文档存放的位置；

-author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者；

-version：用来指定生成的帮助文档必须显示该类的版本，如果没有这一命令则生成的帮助文档将不会显示版本；

④、点击回车键。

2、java的API帮助文档是通过文档注释来完成的，这一文档是通过网页来显示的，这一文档又称为程序说明文档

3、注意点：

①、如果该类要生成帮助文档，则该类必须是public类型(排除其它类型，包括排除protected)的，否则在执行命令的过程中会出现问题；

②、打开生成的帮助文档，你会发现test3和test4方法并在帮助文档中没有生成相应的文档信息，这里要知道：类中的方法除了public和protected修饰的以外，其它访问权限的方法文档注释是不会提取的。