Java API文档的生成(javadoc.exe)

协作开发过程中，可能别人需要用你封装的类库，这就避免不了，你要告诉他，我这个类的方法分别是实现什么功能，方法需要传入什么类型的参数表和方法是否会有返回值等。如果能生成简要的类使用说明文档，统一格式说明，是不是能减少一些沟通成本。那么如何生成API帮助文档呢？先结合下eclipse做下说明

详细流程如下图

选择功能，导出



2、选择javadoc



3、配置 javadoc ncommand ，选择生成API帮助文档的文件位置



4、生成后在目录下有doc 文件夹，打开index.html



5、查看API文档，在浏览器中打开。



备注 ： 具体的工具类请看文章后面的demo传送门

java 总共有三种注释 :

单行注释 :  //

多行注释:  /**/

文档注释: /***/

下载demo查看工程里面的Tool.class和对应API说明文档index.html