第二章《Java程序世界初探》第3节：在程序中添加注释

注释的作用是解释程序。一段程序中如果添加了合理的注释，可以帮助人们快速、准确的理解程序。Java语言中注释有三种：

1.单行注释

单行注释的写法是“//”，编译器会认为“//”开头的字符一直到文本的末尾都是注释。因为这种注释覆盖的范围仅是从“//”开头一直到文本的末尾，不能跨越到其他行，所以被称为“单行注释”。单行注释往往用来解释一条语句的作用，通常程序员都会把单行注释写在语句的上方或后面，如图2-5和2-6所示。

图2-5 在语句上方添加单行注释

图2-6 在语句后面添加单行注释

2.多行注释

如果注释包含的内容比较多，一句话无法表达清楚注释的含义，这时就可以在程序中添加“多行注释”。Java语言中，多行注释以“/*”开头，以“*/”结尾，开头和结尾中间的部分均属于注释内容，多行注释的内容可以跨好几行，因此常常用来书写大段的解释性文字，如图2-7所示。

图2-7 在程序中添加多行注释

3.文档注释

文档注释和多行注释非常相似，也可以跨越多行。它以“/**”开头，以“*/”结尾。程序员在开发完一个规模较大的软件系统之后，为了详细解释程序中各个类或方法的功能，经常使用JDK自带的javadoc程序来生成一份说明文档。文档注释中的内容就可以出现在所生成的帮助文档中，而多行注释中的内容则不会在帮助文档中出现，这就是文档注释与多行注释的区别。文档注释一般都会被添加到类名称的上方或方法名称的上方。添加到类名称上方的文档注释被称为“类注释”，而添加到方法名称上方的注释被成为“方法注释”。

在System.out.println("Hello World!");这条语句中，开头的“System”就是JDK基础类库中所定义的一个类，读者可以在代码编辑窗口中按下Ctrl键，然后把鼠标箭头移动到“System”这个单词的上方，就会看到鼠标的箭头变成了一个小手的形状，然后单击鼠标左键，就能看到System类的源代码。在这段源代码中，System类上方就添加了一段类注释，如图2-8所示。

图2-8 System类的类注释

在图2-8中所示的类注释当中，出现了“@since 1.0”的字样，它表示这个类在JDK1.0版本就已经被定义。文档注释中以@开头的标记叫做“通用注释”，它们都有着特定意义，常见的通用注释如表2-3所示。

表2-3 常见通用注释

除阅读文章外，各位小伙伴还可以点击这里观看我在本站的视频课程学习Java！