注释（comment）

在Java的编写过程中我们需要对一些程序进行注释，除了自己方便阅读，更为别人更好理解自己的程序，所以我们需要进行一些注释，可以是编程思路或者是程序的作用，总而言之就是方便自己他人更好的阅读。

注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。

单行注释

单行注释是最常用的注释方式。以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。

public class FirstSample{
    // main 方法，Java 应用程序的入口
    public static void main(String[] args){
        // 向控制台输出语句 "Hei,Hei".
        System.out.println("Hei,Hei");
        // 下面这句代码被注释掉了，不会执行！
        // System.out.println("Hei,Hei! Again.");
    }
}

多行注释

多行注释，注释内容放到 /* 和 */之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观）

注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。

public class FirstSample{
    /* 可以注释一行内容，main 方法，Java 应用程序的入口 */
    public static void main(String[] args){
        System.out.println("Hei,Hei");
        /*
        也可以注释多行内容
        System.out.println("不知道说什么了，举什么例子好呢？");
        System.out.println("Hei,Hei! Again.");
            */
    }
}

javaDoc 文档注释

javaDoc 文档注释： Java 语言提供了专门用于生成文档的注释。文档注释是以 "/ ** " 开始，以 "*/"结束的。也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容。

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

注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。

API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分，需要使用 -private。

/**
This is a simple class.
@author 作者：夜雨流云.
@date 日期：2020年8月02日 15:16:31.
@version 1.0
*/
public class FirstSample{
    public static void main(String[] args){
        System.out.println("Hei,Hei");
    }
}

Javadoc 标签

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。

对两种标签格式的说明：

• @tag 格式的标签（不被{ }包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）。
• {@tag} 格式的标签（由{ }包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。

Javadoc 标签注意事项：

• Javadoc 标签必须从一行的开头开始，否则将被视为普通文本。
• 一般具有相同名称的标签放在一起。
• Javadoc 标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成 API 帮助文档时会检测不到该注释内容。

Javadoc命令

Javadoc 用法格式如下：

javadoc [options] [packagenames] [sourcefiles]

对格式的说明：

• options 表示 Javadoc 命令的选项；
• packagenames 表示包名；
• sourcefiles 表示源文件名。

在 cmd（命令提示符）中输入javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK）

Javadoc 命令的常用选项

DOS命令生成API帮助文档

新建一个空白记事本，输入下列代码：

/**
* @author yyly
* @version jdk1.8.0
*/
public class Test{   
    /**     
    * 求输入两个参数范围以内整数的和     
    * @param n 接收的第一个参数，范围起点     
    * @param m 接收的第二个参数，范围终点     
    * @return 两个参数范围以内整数的和     
    */    
    public int add(int n, int m) {        
        int sum = 0;        
        for (int i = n; i <= m; i++) {            
            sum = sum + i;        
        }        
        return sum;    
    }
} 

将文件命名为 Test.java，打开 cmd 窗口，输入javadoc -author -version Test.java命令。如图所示。

img

打开 Test.java 文件存储的位置，会发现多出了一个 Test.html 文档。打开文档，文档页面如图所示。

img

注意：以上没有考虑编码格式的问题，注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题。

开发工具生成API帮助文档

1）在 新建一个 Test 类，代码如下：

package test;
/**
* @author yyly
* @version jdk1.8.0
*/
public class Test {   
    public static void main(String[] args) {        
        /**         
        * 这是一个输出语句         
        */        
        System.out.println("这是一段注释");    
    }
}

注意：代码 9~11 行没有放在类、成员变量或方法之前，所以 Javadoc 会忽略这个注释。

2）在项目名处单击鼠标右键，然后选择Export...，如图 所示。

img

3）在弹出窗口中选择 Java 文件夹，点击 Java 文件夹下面的 Javadoc，然后点击“Next”，如图 5 所示。

img

4）选择你要生成 Javadoc 的项目，更改你想保存的 API 帮助文档地址（默认为工程目录下，建议不要修改）。点击“Finish”，如图所示。

img

5）点击“Finish”之后会问是否更新 Javadoc 文件的位置，只需要点击“Yes To All”即可，如图所示。

img

6）这时可以看到控制台输出生成 Javadoc 的信息，如图 所示。

img

7）打开保存的文件夹，找到 Test.html 文件并打开，如图所示。

img

文档注释的格式

在编写文档注释的过程中，有时需要添加 HTML 标签，比如：需要换行时，应该使用<br>，而不是一个回车符；需要分段，使用<p>。

例如把上面 Test 类改为以下代码：

package test;
/**
* @author yyly<br>
*         ycs
* @version 1.8.0<br>
*          1.9.0
*/
public class Test {    
    public static void main(String[] args) {        
        System.out.println("这是一个注释");    
    }
}

Javadoc 并不是将代码中的文档注释直接复制到帮助文档的 HTML 文件中，而是读取每一行后，删除前面的*号及*以前的空格再输入到 HTML 文档。

/**
\* first line.
******* second line.
\* third line.
*/

编译输出后的 HTML 源码如下所示。

first line. <br>
second line. <br>
third line.

注释前面的*号允许连续使用多个，其效果和使用一个*号一样，但多个*前不能有其他字符分隔，否则分隔符及后面的*号都将作为文档的内容。

总结

一个程序的可读性，关键取决于注释。如果一个程序想二次开发，要读懂前面的程序代码，就必须在程序中有大量的注释文档，所以对于一个优秀的程序员来说，学会在程序中适当地添加注释是非常重要的。

注释除了帮助别人了解编写的程序之外，还对程序的调试、校对等有相当大的帮助。

当程序具体运行时，计算机会自动忽略注释符号之后所有的内容。

绍类、方法、字段等地方的注释方法，这些地方的注释虽然简单但是在开发工作中却是非常重要的。

• 一行注释以双斜杠“//”标识，当编译器执行到“//”时，就会忽略该行“//”之后的所有文本；
• 多行注释包含在“/”和“/”之间，当编译器执行到“/*”时，会扫描下一个“*/”并忽略“/*”和“*/”之间的任何文本；
• 文档注释包含在“/**”和“*/”之间，当编译器执行到“/**”时，也会扫描下一个“*/”并忽略“/**”和“*/”之间的任何文本内容。

类注释

类注释一般必须放在所有的“import”语句之后，类定义之前，主要声明该类可以做什么，以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。

/** 
* @projectName（项目名称）: project_name 
* @package（包）: package_name.file_name 
* @className（类名称）: type_name 
* @description（类描述）: 一句话描述该类的功能 
* @author（创建人）: user  
* @createDate（创建时间）: datetime   
* @updateUser（修改人）: user  
* @updateDate（修改时间）: datetime 
* @updateRemark（修改备注）: 说明本次修改内容 
* @version（版本）: v1.0 */

提示：以上以@开头的标签为 Javadoc 标记，由@和标记类型组成，缺一不可。@和标记类型之间有时可以用空格符分隔，但是不推荐用空格符分隔，这样容易出错。

一个类注释的创建人、创建时间和描述是不可缺少的。下面是一个类注释的例子。

/** 
* @author: zhangsan 
* @createDate: 2018/10/28 
* @description: this is the student class. 
*/
public class student{    
    .................
}

注意：没有必要在每一行的开始用*。例如，以下注释同样是合法的：

/**   
@author: zhangsan   
@createDate: 2018/10/28   
@description: this is the student class. 
*/
public class student{    
    .................
}

方法注释

方法注释必须紧靠在方法定义的前面，主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外，还可以使用下列的以@开始的标签。

• @param 变量描述：对当前方法的参数部分添加一个说明，可以占据多行。一个方法的所有 @param 标记必须放在一起。
• @return 返回类型描述：对当前方法添加返回值部分，可以跨越多行。
• @throws 异常类描述：表示这个方法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。

下面是一个方法注释的例子。

/** 
* @param num1: 加数1 
* @param num2: 加数2 
* @return: 两个加数的和 
*/
public int add(int num1,int num2) {    
    int value = num1 + num2;    
    return value;
}

以上代码的 add() 方法中声明了两个形参，并将它们两个的和作为返回值返回。

为类的构造方法添加注释时，一般声明该方法的参数信息，代码如下。

public class Student {   
    String name;   int age;   
    /**    
    * @description: 构造方法    
    * @param name: 学生姓名    
    * @param age: 学生年龄    
    */   
    public Student(String name,int age) {   
        this.name = name;    
        this.age = age;   
    }
}

字段注释

字段注释在定义字段的前面，用来描述字段的含义。下面是一个字段注释的例子。

/** 
* 用户名 
*/
public String name;

也可以使用如下格式：

//用户名
public String name;

在 Java 的编写过程中我们需要对一些程序进行注释，除了自己方便阅读，更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的，希望读者不要忽视它。