eclipse生成标准的API文档

小鱼儿 2022-05-09 02:10 221阅读 0赞

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

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

![1040464-20171021180842537-1054880174.png][]

2、Next

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

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

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

![1040464-20171021182751677-1246475515.png][]

3、继续下一步

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

（2）点击【Next】按钮

![1040464-20171021182008568-1963114171.png][]

4、继续下一步

（1）选择使用的jdk版本

（2）点击【Finish】按钮

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

![1040464-20171021182120990-356536122.png][]

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

![1040464-20171021182236724-1306872978.png][]

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

![1040464-20171021182320521-1721359829.png][]

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

![1040464-20171021182415771-1291326017.png][]

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

![1040464-20171021182503271-2064356471.png][]

转载自：[https://www.cnblogs.com/wdh1995/p/7705494.html][https_www.cnblogs.com_wdh1995_p_7705494.html]

[1040464-20171021180842537-1054880174.png]: /images/20220509/8f50a33c1b254491beefa6b207f3821b.png
[1040464-20171021182751677-1246475515.png]: /images/20220509/bb3e8f4b8e8b4671b8bd7bcb6cf8b10a.png
[1040464-20171021182008568-1963114171.png]: /images/20220509/f2b780de9478485bb0ca399462eadc9d.png
[GBK]: http://www.cnblogs.com/wdh1995/p/7705441.html
[1040464-20171021182120990-356536122.png]: /images/20220509/f8d67199382b4df9a3faf738400bbbf6.png
[1040464-20171021182236724-1306872978.png]: /images/20220509/e45f02b0d1cf4cc6b09f4901ae6bed80.png
[1040464-20171021182320521-1721359829.png]: /images/20220509/ccd77392d0f6488a8b0e437e60e0e9e3.png
[1040464-20171021182415771-1291326017.png]: /images/20220509/c22f2d37cb244da18ef86d454a2615a8.png
[1040464-20171021182503271-2064356471.png]: /images/20220509/6ffce921f17a41d5b2aa4b47d9f75b91.png
[https_www.cnblogs.com_wdh1995_p_7705494.html]: https://www.cnblogs.com/wdh1995/p/7705494.html