Java注释常用标签实例

1、@see:引用其他类

@see标签允许你引用其他类的文档。javadoc会在其生成的HTML文件中,用@see标签链接到其他文档。

2、@link package。class#member label

该标签与@see及其相似,只是它可以用于行内,并且是用“label”作为超链接文本而不用“See Also”

3、@docRoot

该标签产生到文档根目录的相对路径,用于文档树页面的显示超链接

4、inheritDoc

该标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中

5、@version

该标签格式如下:

@version version-information

其中,“version-information”可以是任何你认为适合作为版本说明的重要信息,如果javadoc命令行使用了“-version”标记,那么久可以从生成的HTML文档中提取出版本信息

6、@author

该标签的格式如下:

@author author-information

其中,“author-information”,望文生义你也知道,应该是你的名字,也可以包括电子邮件地址或者其他任何适宜的信息

7、@since

该标签允许你指定程序代码最早使用的版本,你将会在HTML java文档中看到他被用来指定所用的JDK版本

8、@param

该标签用于方法文档中,形式如下:

@param parameter-name description

其中,parameter-name是方法的参数列表中标识符

9、@throws 

异常

10、@deprecated

该标签用于指出一些旧特性已由改进的新特性所取代,建议用户不要使用这些旧特征。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值