Java 中的注释

注释的作用

注释是对代码的解释和说明，其目的是让程序员能够更加快速的理解代码。它是编写程序时，写程序的人给一个语句、程序段等的解释或提示，能提高程序代码的可读性。我认为添加注释，是为了程序更容易理解与维护，特别是维护，更是对自己代码负责的一种体现。

注释在编译的时候不会生成到 class 字节码文件当中，它只在 java 源文件中保留。

注释的三种方式

Java 语言的注释包括三种方式，它们分别是：

第一种：单行注释，语法格式如下：

// 单行注释，两个正斜杠后面的内容被注释

第二种：多行注释，语法格式如下：

/*
这里的注释信息为多行注释：
第 1 行注释信息
第 2 行注释信息
*/

第三种：javadoc 注释。

注意：对于 javadoc 注释来说，这里的注释会被 JDK bin 目录下的 javadoc.exe 命令解析并生成帮助文档（生成帮助文档后期做项目的时候大家会接触到的）。

注释应该怎么写

编写注释是程序员最基本的素质，养成编写注释的好习惯，要有编写注释的意识。当然，写注释也是有技巧的，不是所有位置都写，不是把写的代码原版翻译过来，老程序员往往在写注释的时候，不多不少，能够做到恰到好处，几句话就可以描述清楚程序的核心功能。

通常要在类和接口上写注释，这一部分注释是必须的。在这里，我们需要使用 javadoc 注释，需要标明：创建者，创建时间，版本，以及该类的作用。在方法中，我们需要对入参，出参，以及返回值，均要标明。对常量，我们需要使用多行注释，进行标明该常量的用途。在关键算法上，添加注释并且按照顺序依次标明，写明白该方法为什么这么做。

记住：注释的作用不在于表示代码的含义，而在于表示代码的功能。希望在以后的课程当中通过慢慢的培养，能够写一手漂亮的注释，当然，目前大家只需要掌握注释有哪几种，分别写到什么符号里就行了。

为 HelloWorld 提供注释

接下来我们为 HelloWorld 程序提供简单的注释信息，来练习一下注释的编写：

/**
* 我的第一个 Java 程序问世了
* @author kxf
* @version 1.0
* @since 1.0
*/
public class HelloWorld {
 /**
 * 这是程序的入口
 * @param args 参数
 */
 public static void main(String[] args) {
 // 向控制台输出一段话
 System.out.println("HelloWorld ！");
 }
}

通过以上代码我们可以看到，HelloWorld 类上写了一个 javadoc 注释，在 javadoc 注释中提供了对这个类的整体描述信息、作者信息、版本号信息等。在 main 方法上提供了 javadoc 注释，对这个方法进行了说明，对参数进行了说明等。在输出信息的那行代码上提供了单行注释，说明了这行代码的作用。

本站仅提供存储服务，所有内容均由用户发布，如发现有害或侵权内容，请点击举报。