2015年9月22日星期二

javadoc常用的标记符

 @author:指定Java程序的作者
 @version:指定源文件的版本
 @deprecated:不推荐使用的方法
 @param:方法的参数说明信息
 @return:方法返回值说明信息
 @see:“参见”,用于指定交叉参考的内容
 @since: 最早出现的JDK版本
 @exception:抛出异常的类型
 @throws:抛出的异常,和exception同义
 @link package.class#成员 标签: 连接到某个特定的成员对应的文档中
 @value: 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
 <p>
 </br>
需要指出的是,这些标记的使用是有位置限制的。上面这些标记可以出现在类或者接口文档注释中的有@see、@deprecated、@author、@version等;可以出现在方法或构造器(构造方法)文档注释中的有@see、@deprecated、@param、@return、@thorws和@exception等;可以出现在Field(成员变量)文档注释中的有@see和@deprecated等。如下:
/**
 * Description:
 * <br/>Copyright (C), 2014, Jion.tang
 * <br/>This program is protected by copyright laws.
 * <br/>Program Name:
 * <br/>Date:
 * @author  Jion.tang qimortal@163.com
 * @version  1.0
 */
 public class JavadocTest
 {
  /**
   * 简单测试Field
  */
  public String name;
  /**
   * 一个得到打招呼字符串的方法
   * @param name 该参数指定向谁打招呼
   * @return 返回打招呼的字符串
   *
  */
  public String hello(String name)
 {
  return name + "你好!";
  }
  /**
   * 主方法,程序的入口
  */
  public static void main(String[] args)
 {
  System.out.println("Hello World!");
  }
 }

没有评论:

发表评论