eclipse如何为java项目生成API文档、JavaDoc

当咱们的项目很大，编写了不少代码的时候，就须要生成一个标准的API文档，让后续的开发人员，或者合做者能够清晰的了解您方法的使用，那么如何将本身的项目生成API文档呢？

一、点击eclipse的【Project】菜单，选择【Generate JavaDoc】选项。

二、Next

（1）选择您要生成JavaDoc的工程

（2）选择哪些级别的内容生成JavaDoc，默认为public，若是选择private则会所有内容都生成。

（3）选择doc的生成位置，默认为工程目录下，建议不要修改。

 

三、继续下一步

（1）勾选Document Title，而后填写文档标题。

（2）点击【Next】按钮

四、继续下一步

（1）选择使用的jdk版本

（2）点击【Finish】按钮

注意这里加上一个：-encoding UTF-8 -charset UTF-8，能够解决  编码GBK的不可映射字符”问题

五、能够看到控制台输出生成javadoc的信息。

六、项目下生成一个【doc】的目录，里面存放着javadoc文档。

七、打开doc目录，用浏览器打开index.html

八、最终能够看到一个完整的API文档、javadoc就生成了。