注释
在源代码找中添加以专用的定界符/**开始的注释,可以很容易地生成看上去具有专业水准的文档。
每个文档注释在标记之后紧跟着自由格式文本,标记由@开始。
方法注释:
每一个方法注释必须放在所描述的方法之前。
@param变量描述:对当前方法的参数部分描述
@return描述:对当前方法添加return返回部分,这个描述可以跨越多行,并可以用HTML 描述
@throws类描述:添加一个注释,用于表示有可能抛出异常
通用注释:
@author姓名:产生一个作者条目,可以使用多个@author标记,每一个标记对应一个作者
@version文本:产生一个版本条目,这个文本是对当前文本的任何描述。
@since文本:产生一个始于条目,这里的text可以是对引入特性的版本描述
@deprecated文本:对类,方法或者变量添加一个不再使用的注释
@see引用:将在“see also”部分添加一个超级链接,链接到javadoc文档的相关部分或外部文档
注释
最新推荐文章于 2022-11-13 20:15:03 发布