java基础01之注释

注释

注释的意义

在代码量较少的时候，我们还可以看懂自己所写的代码，可是当代码撸得比较多、项目结构复杂的时候，如果没有注释，我们就需要一点点往前翻才可能了解哪块代码是干什么的。因此注释在项目中是必不可少的。
除此之外，注释还可以帮助我们读懂他人的代码或者帮助别人读懂我们自己的代码。
注释并不会被执行，是给我们程序员阅读的。
书写注释是一个非常好的习惯。

Java中的三种注释

• 单行注释
  采用双斜杠//将该行后面的文字进行注释

public class HelloWorld{
	public static void main(String[] args){
		//单行注释：
		//只能注释一行文字
		System.out.println("Hello,World!");
	}
}

• 多行注释
  采用/**/注释两个*号之间的内容

public class HelloWorld{
	public static void main(String[] args){
		/*
		多行注释：
		可以注释一段文字
		*/
		System.out.println("Hello,World!");
	}
}

• 文档注释
  采用/***/注释中间的内容
  可以加参数，一般用在类、方法和变量上面，用来描述其作用。

public class HelloWorld{
	public static void main(String[] args){
		/**
		*@Description HelloWorld
		*@Author 林讯
		*/
		System.out.println("Hello,World!");
	}
}