Java注释基础用法

Java支持三种类型的注释, 两种会被JavaDoc忽略掉,分别是/* some comment here *///some comment here;第三种注释叫 doc comment,用于生成文档:

/**
  * 将两个数相加
  *
  * @param first 第一个数
  * @param second 第二个数
  * @return 相加之和
  * @since 2016-01-16
  * @author yourName@gmail.com
  */
  public int add(int first, int second){
      return first + second;
  }

常用的注释标签:

标签 描述
@author authorName 已弃用类
@param paramName description 参数
@return valueName description 返回值
@exception exceptionName description 抛出的异常
{@link className} 链接到另一个类
@see className 链接到另一个类
@since date 发布日期
{@inheritDoc} 继承父类注释

评论

退出登录