3.2 注释
与大多数编程语言一样,Java中的注释不会出现在可执行程序中。因此,您可以根据需要添加任意多的注释,而不必担心代码膨胀。Java有三种标记注释的方法。最常见的形式是//。对于从//到行尾的注释,可以使用此选项。
System.out.println("We will not use 'Hello, World!'"); //
is this too cute?
当需要较长的注释时,可以用//
标记每行,也可以使用/*
和*/
注释分隔符来实现较长的注释。
最后,使用第三种注释自动生成文档。此注释使用/**
开始,使用*/
结束。您可以在清单3.1中看到这种类型的注释。有关此类注释和自动文档生成的更多信息,请参阅第4章。
清单3.1 FirstSample/FirstSample.java
/**
* This is the first sample program in Core Java Chapter 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中嵌套。也就是说,您可能无法通过用/*
和*/
包围来停用代码,因为您要停用的代码本身可能包含一个*/
分隔符。