JavaDoc注释

Posted 2020-10-02 第4396个梦想

Java最常见的两种注释方法

　　单行注释

　　　　// 注释内容

　　多行注释

　　/*

　　*  注释内容

　　*/

在Java中，还有另一种注释，称为JavaDoc注释

　　/**

　　*Text类

　　*@author    yzw

　　*@version  1.0 2017/08/14

　　*/

　　语法规则

　　1.JavaDoc注释以 /**  开头 */  结束。

　　2.每个注释包含一些描述性的文本以及若干个JavaDoc标签

　　3.JavaDoc标签一般已“@”为前缀，

　　常见的JavaDoc标签及含义

标签	说明	JDK 1.1 doclet	标准doclet	标签类型
@author 作者	作者标识	√	√	包、 类、接口
@version 版本号	版本号	√	√	包、 类、接口
@param 参数名 描述	方法的入参名及描述信息，如入参有特别要求，可在此注释。	√	√	构造函数、 方法
@return 描述	对函数返回值的注释	√	√	方法
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。	√	√	包、类、接口、值域、构造函数、 方法
@throws异常类名	构造函数或方法所会抛出的异常。		√	构造函数、 方法
@exception 异常类名	同@throws。	√	√	构造函数、 方法
@see 引用	查看相关内容，如类、方法、变量等。	√	√	包、类、接口、值域、构造函数、 方法
@since 描述文本	API在什么程序的什么版本后开发支持。	√	√	包、类、接口、值域、构造函数、 方法
{@link包.类#成员 标签}	链接到某个特定的成员对应的文档中。		√	包、类、接口、值域、构造函数、 方法
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。		√(JDK1.4)	静态值域