关于java.doc简单归纳

俗话说一段代码的注释跟代码本身具有同样的重要意义
一个好的码农肯定可以在写好代码的同时兼顾注释的高质量
##首先得学会模仿在java中自带很多的类,我们可以看他们写的java.doc来一步一步的完善和提升自己写java.doc的能力;可以选中一个类+Ctrl+双击进入;
Scanner类
#java.doc最基本的形式
第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束
第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束
第三段:文档标注,用于标注作者、创建时间、参阅类等信息
##特殊的标识符
###@author 作者
作者标识
###@version 版本号
版本号
###@param 参数名 描述
方法的入参名及描述信息,如入参有特别要求,可在此注释。
###@return 描述
对函数返回值的注释
###@deprecated 过期文本
标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。
###@throws异常类名
构造函数或方法所会抛出的异常。
###@exception 异常类名
同@throws。
###@see 引用
查看相关内容,如类、方法、变量等。
###@since 描述文本
API在什么程序的什么版本后开发支持。
###{@link包.类#成员 标签}
链接到某个特定的成员对应的文档中。
@link的使用语法{@link 包名.类名#方法名(参数类型)},其中当包名在当前类中已经导入了包名可以省略,可以只是一个类名,也可以是仅仅是一个方法名,也可以是类名.方法名,使用此文档标记的类或者方法,可用通过按住Ctrl键+单击 可以快速跳到相应的类或者方法上,解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>
###{@value}
当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。

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

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值