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

矫情吗；* 2023-06-21 07:24 25阅读 0赞

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

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

![format_png][]

2、Next

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

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

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

![format_png 1][]

3、继续下一步

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

（2）点击【Next】按钮

![format_png 2][]

4、继续下一步

（1）选择使用的jdk版本

（2）点击【Finish】按钮

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

![format_png 3][]

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

![format_png 4][]

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

![format_png 5][]

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

![format_png 6][]

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

![format_png 7][]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MDg0MjUzNy0xMDU0ODgwMTc0LnBuZw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4Mjc1MTY3Ny0xMjQ2NDc1NTE1LnBuZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjAwODU2OC0xOTYzMTE0MTcxLnBuZw?x-oss-process=image/format,png
[GBK]: http://www.cnblogs.com/wdh1995/p/7705441.html
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjEyMDk5MC0zNTY1MzYxMjIucG5n?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjIzNjcyNC0xMzA2ODcyOTc4LnBuZw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjMyMDUyMS0xNzIxMzU5ODI5LnBuZw?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjQxNTc3MS0xMjkxMzI2MDE3LnBuZw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE3LmNuYmxvZ3MuY29tL2Jsb2cvMTA0MDQ2NC8yMDE3MTAvMTA0MDQ2NC0yMDE3MTAyMTE4MjUwMzI3MS0yMDY0MzU2NDcxLnBuZw?x-oss-process=image/format,png