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

        javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。既然javadoc那么好，那么如何生成javadoc帮助文档了，下面将在eclipse中详细操作，并以图文的形式详细展示。

     

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

2.添加完注释之后,如下选择生成API文档

3.填写选项

    a.选择执行的javadoc.exe,

    b.选择要生成API文档的java文件,

    c.选择在那些类型的方法可以参数生成API文档,

    d.选择文档的输出位置

4.填写文档名称

5.这里要指定编码进行编译生成API文档(非常重要!,不填会产生编码错误问题),选择jre的版本,点击finish,就可以了

6.效果图