Eclipse规范注释及注释文档的生成

  1. 首先创建一个java类用于生成Javadoc文档,类的上面添加类注释,有作者和日期等信息,然后为类添加一个方法,使用/**   */为代码添加注释,该注释可用于类上和方法上。注意://注释和/* */注释不会生成Javadoc文档。

    Eclipse规范注释及注释文档的生成

  2. 使用Eclipse生成文档注释:点击Project-->Generate Javadoc,如下图所示。

    Eclipse规范注释及注释文档的生成

  3. 点击Generate Javadoc后,进入弹出的界面,选择javadoc.exe命令的位置,选择要生成Javadoc的包,或者包下的类,以及生成的Javadoc文档所存的路径,默认生成到当前工程目录下,如下图所示。

    Eclipse规范注释及注释文档的生成

    Eclipse规范注释及注释文档的生成

  4. 4

    查看生成的Javadoc文件:在生成文档的目录下会有一堆文件,找到index.html文件,打开查看具体的内容,如下图所示。

    Eclipse规范注释及注释文档的生成