步骤
1.打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2EuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPWQ5ZTI2MGJkYzI1YzEwMzgyNDdlY2VjMjgyMTA5MzFjL2Q0NjI4NTM1ZTVkZGU3MTFhMDVkMjM1MWEzZWZjZTFiOWMxNjYxOGQuanBn.jpg?w=700&webp=1)
2.javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2UuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPWZjOTg0ZjRmYjgzZWIxMzU0NGM3YjdiYjk2MWZhOGNiL2QzMWIwZWY0MWJkNWFkNmVhMTU2MDc0ZDg1Y2IzOWRiYjdmZDNjZWQuanBn.jpg?w=700&webp=1)
3.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2QuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTY0MTZmNjFjODNkNjI3N2ZlOTEyMzIzODE4MzkxZjYzLzQ3MjMwOWY3OTA1Mjk4MjI5MTE5NWI2NGQzY2E3YmNiMGE0NmQ0NmIuanBn.jpg?w=700&webp=1)
4.(1)选择您要生成JavaDoc的工程
(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。
(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
(5)点击【Next】按钮
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2guaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTZhMjYxN2RkMjRhNDQ2MjM3ZWNhYTU2MmE4MjM3MjQ2L2M3NWMxMDM4NTM0M2ZiZjJiNTE1Y2I4NGI0N2VjYTgwNjUzODhmNWYuanBn.jpg?w=700&webp=1)
5.(1)勾选Document Title,然后填写文档标题。
(2)点击【Next】按钮
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2EuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTY4NjNhMThlODIxODM2N2FhZDg5N2ZkZDFlNzI4YjY4LzI3OTc1OWVlM2Q2ZDU1ZmI2YWM5MWE4MTY5MjI0ZjRhMjBhNGRkMGUuanBn.jpg?w=700&webp=1)
6.
(1)选择使用的jdk版本
(2)点击【Finish】按钮
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2MuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTE2MmI1YWFjNWZiNWM5ZWE2MmYzMDNlM2U1MzhiNjIyLzM4MDEyMTNmYjgwZTdiZWM3NjU3NmY0NjJiMmViOTM4OWE1MDZiODMuanBn.jpg?w=700&webp=1)
7.
可以看到控制台输出生成javadoc的信息。
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2UuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPWUyNzIzMWY3MDgzMzg3NDQ5Y2M1MmY3YzYxMGVkOTM3L2IzYjdkMGEyMGNmNDMxYWRkZmI5MmM5ZTRmMzZhY2FmMmVkZDk4MjkuanBn.jpg?w=700&webp=1)
8.
项目下生成一个【doc】的目录,里面存放着javadoc文档。
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2MuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTFkMWE4ZmY1ODEzNWU1ZGQ5MDJjYTVkZjQ2YzdhN2Y1L2JkM2ViMTM1MzNmYTgyOGJmNGM2ZjI0NGY5MWY0MTM0OTYwYTVhYWIuanBn.jpg?w=700&webp=1)
9.
打开doc目录,用浏览器打开index.html
![eclipse中javadoc给项目生成api文档 eclipse中javadoc给项目生成api文档](https://image.shishitao.com:8440/aHR0cDovL2IuaGlwaG90b3MuYmFpZHUuY29tL2V4cC93PTUwMC9zaWduPTIyN2EwMDIyY2RlYTE1Y2U0MWVlZTAwOTg2MDEzYTI1LzIwM2ZiODBlN2JlYzU0ZTcxNzkwNzRiOWJkMzg5YjUwNGZjMjZhMWMuanBn.jpg?w=700&webp=1)
注意点
有的时候生成的文档是中文乱码的,这个时候在第六步的时候需要加上-encoding UTF-8 -charset UTF-8