JavaSE —— 注释（comment）

注释（comment）

用于注解说明解释程序的文字就是注释

• Java中的注释类型：

  • 单行注释
  • 多行注释
  • 文档注释（Java特有）

• 注释的作用：

  • 对所写的程序进行解释说明，提高了代码的可读性
  • 调试程序
  • 便于后期程序的维护

• 注释的内容不产与编译（编译后生成的字节码文件中不包括注释掉的信息）

• 注释是一个程序员必须要具有的良好编程习惯

• 我们写程序是可以先将自己的思想通过注释整理出来，再用代码去体现

1、单行注释

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

package comment;

public class SingleLineComment {
    public static void main(String[] args) {
        // 单行注释:此处用来测试测试程序
        // System.out.println("单行注释的内容不参与程序的编写");

        // 单行注释:此处用于简单的解释说明程序
        // 在控制台中输出 “Hello World”
        System.out.println("Hello World");
    }
}

运行结果：

Hello World

2、多行注释

包含在 “/” 和 “/” 之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息

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

package cn.edu.hziee.comment.doc;

public class MultiLineComment {
    /*
    多行注释
    在控制台输出 HelloWorld
     */
    public static void main(String[] args) {
        System.out.println("HelloWorld");
    }
}

3、文档注释

注释内容可以被 JDK 提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档

package comment;

public class DocumentationComment {
    //文档注释格式
    /**
     * 文档注释
     * @author WuYufan
     * @version v1.0
     */
    public static void main(String[] args) {
        System.out.println("add(1, 2) = " + new DocumentationComment().add(1, 2));
    }

    /**
     * 求输入两个参数范围以内整数的和
     * @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;
    }

}

javadoc

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

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

Javadoc 标签

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

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据	@serialData description
@serialField	说明一个 ObjectStreamField 组件	@serialField name type description
@since	说明从哪个版本起开始有了这个函数	@since release
@throws	和 @exception 标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是 static 属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本，一般用于类注释	@version info

对两种标签格式的说明：

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

Javadoc 标签注意事项：

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

Javadoc 用法格式如下：

javadoc [options] [packagenames] [sourcefiles]

对格式的说明：

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

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

名称	说明
-public	仅显示 public 类和成员
-protected	显示 protected/public 类和成员（默认值）
-package	显示 package/protected/public 类和成员
-private	显示所有类和成员
-d	输出文件的目标目录
-version	包含 @version 段
-author	包含 @author 段
-splitindex	将索引分为每个字母对应一个文件
-windowtitle	文档的浏览器窗口标题

PS D:\WorkSpace\Java\JavaSE_Study\src\comment> javadoc -d doc -author -version DocumentationComment.java
Loading source file DocumentationComment.java...
Constructing Javadoc information...
Creating destination directory: "doc\"
Standard Doclet version 11.0.15.1
Building tree for all the packages and classes...
Generating doc\comment\DocumentationComment.html...
DocumentationComment.java:11: warning: no @param for args
    public static void main(String[] args) {
                       ^
Generating doc\comment\package-summary.html...
Generating doc\comment\package-tree.html...
Generating doc\constant-values.html...
Building index for all the packages and classes...
Generating doc\overview-tree.html...
Generating doc\index-all.html...
Building index for all classes...
Generating doc\allclasses-index.html...
Generating doc\allpackages-index.html...
Generating doc\deprecated-list.html...
Building index for all classes...
Generating doc\allclasses.html...
Generating doc\allclasses.html...
Generating doc\index.html...
Generating doc\help-doc.html...
1 warning
PS D:\WorkSpace\Java\JavaSE_Study\src\comment> 

可以发现生成一个 doc 文件夹

进入 doc 目录

双击打开 index.html

点击 DocumentationComment