eclipse的java帮助文档_使用eclipse生成javadoc帮助文档

使用eclipse生成javadoc帮助文档

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

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

方式一：

1.首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”Export“选项。

2.在弹出来的”Export“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”Next“按钮。

3.进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置。在Create

Javadoc for

members...一栏选择哪些级别的内容生成JavaDoc，默认为public，如果选择private则会全部内容。在“Use