Javadoc学习及使用

简介

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

我们常用的java api doc就是Javadoc

如果编写Javadoc

注释格式

Java里通常支持三种格式注释。


// 第一种注释,双斜线,不支持换行

/* 第二种,支持换行,这里面的都是注释 */

/**
 * 第三种,在斜线后,有两个星号,这样的注释,便是Javadoc文档注释
 */
/** Javadoc文档注释也可以不换行 */

第三种,以/*开头的注释,便被称为Javadoc注释。

常用的tag

tag 描述 例子
@author 用于class和interface的声明中,表示作者 @author 作者名
@param 用于构造函数及函数的参数说明 @param 参数名 参数说明
@return 表示函数的返回值 @return 函数返回值说明
@throws 标识出方法可能抛出的异常 @throws RuntimeException 描述
@exception 和@throws一样,官网推荐用@throws
@see 链接目标,@see Tag只能顶格写 @see 其他类
{@link} 和@see类似,但可以放在任意位置 {@link 其他类名}
@since 引入新功能 @since 2.0,2.0版本开始加入的新功能
@version 指定类的版本 @version info
@deprecated 类或成员deprecated
{@value} 显示常量的值,该常量必须是final属性
{@code }
{@docRoot} 文档的根路径

Tag功能介绍

@author

默认Javadoc是不显示@author Tag的内容的。

如果打算在Javadoc里显示@author的内容,可以在生成Javadoc的时候,添加参数 -tag author:a:”Author:”

@return

当Tag @return用在返回值为void的函数上或者构造函数,@return会被忽略

@see

@see “string”

如果在@see后面添加一段文本字符串,则不会生成连接。Javadoc 工具会根据文本前的双引号来进行识别
例如:
@see “The Java Programming Language”
生成的结果就是

See Also:
     "The Java Programming Language"

@see label

跳转到相应连接

@see package.class#member label

跳转到相应class的成员或class

@see 的查找

如果在class内,可以不加包和类的限定名

/**
  * @see  #field
  * @see  #method(Type, Type,...)
  */

在当前package或引用的package内查找

/**
  * @see  Class#field
  * @see  Class#method(Type, Type,...)
  */

在其他package内查找

/**
  * @see  package.Class#field
  * @see  package.Class#method(Type, Type,...)
  * @see package.Class
  */

@see Tag内的名称,的查找次序为:

1. 当前classinterface
2. enclosing classes
3. 父类或父接口
4. 当前包
5.import次序,查找import的包,classinterface

{@value}

{@value} 在生成的doc里,会用变量的真实值替换{@value}出现的地方。有两种用法:

一种是没有参数,只能用在final修饰的成员变量上

/**
 * The value of this constant is {@value}.
 */
public static final String SCRIPT_START = "
                    
                    

你可能感兴趣的:(java)