Java核心技术I:3.2 注释

87 阅读2分钟

前言

大家好,我是一名前端开发者,大家可以叫我「十木化云子」。近期,由于工作需求和对后端开发的个人兴趣,我开始阅读《Java核心技术》第12版的英文原版。我计划一边学习这本书,一边记录并分享我的学习心得,有的会直接翻译。

由于我的英文水平有限,理解错误和其他问题在所难免。因此,我非常欢迎大家提出任何形式的批评和建议。你们的反馈将对我非常有帮助。

3.2 注释

Java中的注释,和大多数编程语言一样,不会出现在可执行程序中(这里的意思是不会被执行)。因此,你可以根据需要添加尽量多的注释,而不必担心代码会变得臃肿。Java有三种方式来标记注释。

最常见的形式是使用 //。这种注释从 // 开始,一直到该行的末尾。

System.out.println("We will not use 'Hello, World!'"); // 这算不算太可爱了?

当需要更长的注释时,你可以用 // 标记每一行,或者使用 /**/ 注释定界符来标记一个更长的注释。

最后,第三种类型的注释用于自动生成文档。这种注释使用 /** 开始,用 */ 结束。你可以在清单 3.1 中看到这种类型的注释。有关这种类型的注释以及自动生成文档的更多信息,请参见第4章。

代码清单 3.1 FirstSample/FirstSample.java

/**
  * 这是 Core Java 第3章中的第一个示例程序
  * @version 1.01 1997-03-22
  * @author Gary Cornell
*/
public class FirstSample
{
  public static void main(String[] args)
  {
    System.out.println("We will not use 'Hello, World!'");
  }
}

*注意*

/* */ 注释在 Java 中不是嵌套的。也就是说,你可能无法通过用 /**/ 包围一段代码来简单地停用它,因为你想停用的代码本身可能包含一个 */ 定界符。