Java程序设计实战教程
上QQ阅读APP看书,第一时间看更新

2.1.2 注释

为了使代码易于阅读、更加清晰易懂、便于团队协作,通常需要在程序中为代码添加一些注释,对程序的某行代码或某个功能模块进行解释说明。注释只在Java源文件中有效,编译器编译时会忽略注释,注释不会被编译到字节码文件中去。Java有以下3种类型的注释方式。

1.单行注释

用来对程序中的某一行代码进行解释说明,使用符号//,符号后面是注释内容,语法格式为://注释内容。单行注释放在要解释说明的那一行代码的后面,注释内容不能太长、不能换行,太长要换行的话要用到多行注释。代码如下。


System.out.println("Hello World!!!");   //输出字符串

这里在代码行的右边添加了注释来说明这一行的功能。除了用于对某一行代码进行解释说明外,在编写代码过程中,如果不确定某一行代码是否该删除,但暂时用不上,也可以在该行代码前面添加单行注释符号,将它“注释”掉,让它暂时失去作用。若后面还用得上该行代码,则删除注释符号//即可。代码如下。


System.out.println("Hello World!!!");   //输出字符串 
//System.out.println("你好 世界!!!");

第二行代码被注释掉了,将不会输出“你好 世界!!!”。若需要重新使用该行代码,只需删除符号//即可。

2.多行注释

多行注释指注释内容为多行,以符号/*开头,符号*/为结尾。语法格式为/*注释内容(多行)*/。除了用来解释说明代码功能外,多行注释还可以一次性将暂时用不上的多行代码“注释”掉。代码如下。


/*System.out.println("Hello World!!!");  
 System.out.println("你好 世界!!!"); */

这样,这两行代码都暂时失去作用。如果需要恢复,删除符号/*和*/即可。

3.文档注释

文档注释用来对类、接口、成员方法、成员变量、静态字段、静态方法、常量或一段代码等进行解释说明,以符号/**开头,符号*/结尾,语法格式为:/**注释内容(多行)*/。可以使用Javadoc文档工具提取程序中的文档注释,生成帮助文档。3种注释综合示例代码如下。


package com.seehope; 
/** 
单位:砺锋科技 
作者:张无忌 
时间:2020-9-1 
*/ 
public class HelloWorld { 
      /* 
      第一个Java程序 
      输出Hello World!!! 
      */ 
      public static void main(String[]args) { 
            System.out.println("Hello World!!!");//输出英文 
            //下面输出中文 
            System.out.println("你好 世界!!!"); 
            System.out.println("你好 中国!!!");   //输出中文 
            //下面暂时不用的语句也可以先注释掉       
            //System.out.println("你好 纽约!!!");                
      } 
}

注释的嵌套:多行注释可以嵌套单行注释,但不能嵌套多行注释。

快速注释技巧如下。

在使用Eclipse编程过程中,常常需要把一些先前写好的代码暂时注释掉, 一行行处理的话很费时,可以使用快捷方式。

方法一:先选中要注释掉的多行代码,然后按Ctrl+/组合键,这时多行代码中的每一行代码都会按单行注释的方式注释掉。代码如下。


public static void main(String[]args) {             
//   System.out.println("Hello World!!!"); 
//   System.out.println("你好 世界!!!"); 
//   System.out.println("你好 中国!!!");             
}

若要取消这种注释,选中已经按这种方法注释掉的多行代码,然后按Ctrl+/组合键即可。

方法二:先选中要注释掉的多行代码,然后按Shift+Ctrl+/组合键,这时多行代码将按多行注释的方式注释掉。代码如下。


public static void main(String[]args) {             
/*   System.out.println("Hello World!!!"); 
     System.out.println("你好 世界!!!"); 
     System.out.println("你好 中国!!!");      */       
}

若要取消这种注释,选中已经按这种方法注释掉的多行代码,然后按Shift+Ctrl+\组合键即可。