eclipse如何为java项目生成API文档、JavaDoc
当我们的项目很大，编写了很多代码的时候，就需要生成一个标准的API文档，让后续的开发人员，或者合作者可以清晰的了解您方法的使用，那么如何将自己的项目生成API文档呢？
操作方法
- 01
注意：本经验使用的eclipse版本为 Eclipse Java EE IDE for Web Developers. Version: Luna Service Release 1 (4.4.1) Build id: 20140925-1800
- 02
打开java代码，编写JavaDoc 注释，只有按照java的规范编写注释，才能很好的生成API文档，javadoc注释与普通注释的区别为多一个*（星号）。普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/
- 03
javadoc注释要尽量写的详细，这样别人在没有源码的情况下才知道如何使用您的代码。
- 04
点击eclipse的【Project】菜单，选择【Generate JavaDoc】选项。
- 05
（1）选择您要生成JavaDoc的工程 （2）选择哪些级别的内容生成JavaDoc，默认为public，如果选择private则会全部内容都生成。 （3）选择doc的生成位置，默认为工程目录下，建议不要修改。 （5）点击【Next】按钮
- 06
（1）勾选Document Title，然后填写文档标题。 （2）点击【Next】按钮
- 07
（1）选择使用的jdk版本 （2）点击【Finish】按钮
- 08
可以看到控制台输出生成javadoc的信息。
- 09
项目下生成一个【doc】的目录，里面存放着javadoc文档。
- 10
打开doc目录，用浏览器打开index.html
- 11
可以看到一个完整的API文档、javadoc就生成了。
赞 (0)