Eclipse自动生成API文档

本文介绍如何在项目中生成JavaDoc文档,包括配置步骤及常用标记的使用方法,如@author、@version等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

选择你的工程。



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同义,抛出异常.可以出现在方法,构造器注释文档中。





评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值