如何在eclipse中，为整个工程生成javadoc文档

如题所述

打开java代码，编写JavaDoc 注释，只有按照java的规范编写注释，才能很好的生成API文档，javadoc注释与普通注释的区别为多一个*（星号）。普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/

javadoc注释要尽量写的详细，这样别人在没有源码的情况下才知道如何使用您的代码。

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

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

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

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

（5）点击【Next】按钮

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

（2）点击【Next】按钮

（1）选择使用的jdk版本

（2）点击【Finish】按钮

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

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

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

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

http://jingyan.baidu.com/article/597a0643485c11312b5243c7.html