【Java】第二节 Java注释

Java注释

注释的作用，给读程序的人提供方便，可以在难以理解的地方提供注释来解释程序，可以注释类、函数、变量的作用等。Java注释的格式有三种：

• 单行注释：//

  class Test {
  	public static void main(String[] args) {
  		//这是单行注释
  		System.out.println("单行注释");
  	}
  }
  

• 多行注释：/* …*/

  class Test {
  	public static void main(String[] args) {
  		/*第一行注释
  		第二行注释
  		第三行注释*/
  		System.out.println("多行注释");
  	}
  }
  

• 文档注释：/**…*/

  class Test {
  	public static void main(String[] args) {
  		/**文档注释：
  		 * 注释。。。
  		 * 注释。。。
  		 */
  		System.out.println("文档注释");
  	}
  }
  

• 多行注释与文档注释的联系与区别：
  • 多行注释与文档注释在程序里面都不会被运行
  • 多行注释不会被编译进字节码文件中，而文档注释则会被编译进字节码文件中
  • 多行注释通常用来解决单行注释太长的情况，而文档注释通常用在程序代码的开头来描述本程序的作者、版本号等信息，或者用在类、对象的开头来描述该类或对象的相关信息