javaDoc注释

概述

Javadoc是Sun公司提供的一项自动生成帮助文档技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签和格式编写注释,在程序完成后,通过Javadoc就可以同时形成程序的帮助文档。

注释类型

javaDoc标记描述
@version指定版本信息
@since指定最早出现版本
@author指定作者
@see添加参见标题,其中有指向reference的链接或者文本项。@see标签有三种形式,下面分别说明:
1.@see “string” 为"string"添加文本项,不产生链接。
2.@see <a href=“URL#Value”>Label使用HTML标记产生链接
3.@see package.claJss#member Label 使用Java语言的名字package.class #member产生链接,与@link类似。
@link生成参考链接,为特定词汇生成链接
{@link package.class#member label} 插入指向package.class#member的内嵌链接
@deprecated标记过期方法,不提倡使用
@param参数
@return返回值
@throw描述抛出的异常,说明抛出的条件

几张图例

在这里插入图片描述
在这里插入图片描述

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值