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

文章转载自: https://www.cnblogs.com/wdh1995/p/7705494.html

当我们的项目很大,编写了很多代码的时候,就需要生成一个标准的API文档,让后续的开发人员,或者合作者可以清晰的了解您方法的使用,那么如何将自己的项目生成API文档呢?

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

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

2、Next

(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

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

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

3、继续下一步

(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

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

4、继续下一步

(1)选择使用的jdk版本

(2)点击【Finish】按钮

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

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

5、可以看到控制台输出生成javadoc的信息。

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

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

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

7、打开doc目录,用浏览器打开index.html

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

8、最终可以看到一个完整的API文档、javadoc就生成了。

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

上一篇:HTML中特殊字符和与之对应的ASCII代码


下一篇:java标识符,关键字,注释及生成Doc文档