现在的位置: 首页 > 综合 > 正文

Eclipse自动生成API文档

2018年05月22日 ⁄ 综合 ⁄ 共 487字 ⁄ 字号 评论关闭

选择你的工程。

Project菜单 --》 generate javadoc

接着


在你的工程里面选择你需要生成javadoc的类。

建议选择 protected级的方法产生doc( 选中它表示protected 和public的方法都产生doc)

javadoc command

C:\Java\jdk1.6.0_37\bin\javadoc.exe  // 跟你的jdk安装位置相关了

点击next --->


可以取个名字先~~~~

最后点击finish大功告成。

常用的javadoc标记如下:
@author:指定java程序作者。可以出现在类或者接口文档注释中。
@version:程序版本。可以出现在类或者接口文档注释中。
@deprecated:不推荐使用的方法。可以出现在类,接口,方法,构造器,属性注释文档中。
@return:方法返回值的说明。可以出现在方法,构造器注释。
@see:指定参考内容。可以出现在类,接口,方法,构造器,属性注释文档中。
@exception:抛出异常类型。可以出现在方法,构造器注释文档中。
@throws:和exception同义,抛出异常.可以出现在方法,构造器注释文档中。

抱歉!评论已关闭.