JavaSE—Java中的注释

1、单行注释

用于对某行代码进行注释

public static void main(String[] args){
            int i = 0;   //定义变量i
           //输出Hello
           System.out.println("Hello");
}

2、块注释

通常用于注释多行代码或用于说明文件、方法、数据结构等的意义与用途，一般位于一个文件或者一个方法的前面，起引导作用

/*main方法负责输出Hello*/
public static void main(String[] args){
//代码省略
}

3、文件注释

用于生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法，以及字段定义之前。注释文档由描述和块标记两部分组成

/**
  *<h1>main方法负责输出Hello</h1>
  *@param args
  *@return
  */
public static void main(String[] args){
               String s = "Hello"; //定义变量s
//代码省略
}

 使用javadoc命令可以为代码生成类似Java API文档的HTML格式文档，代码中的文档注释会体现在此HTML文档中，便于阅读

文档注释中还可以使用各种内置的标签表达特定的含义，例如：

@param args
@return

常见javadoc注释标签语法

注释标签	说明
@author	对类的说明，标明开发该类模块的作者
@version	对类的说明，标明该类模块的版本
@see	对类、属性、方法的说明
@param	对方法中某参数的说明
@return	对方法返回值的说明
@exception	对方法可能抛出的异常的说明