程序员最讨厌两件事,一件事是别人的代码没有注释,另一件事是给自己的代码写注释。
注释有利于帮助我们读懂代码,有时候写了一些复杂的代码,可能过几天就忘记了是怎么写的,这时候就需要注释帮助我们想起来。也可以用注释注释掉我们不想运行的代码。
注释在代码中是不会被执行的,在集成开发环境中显示的颜色也不一样,Java语言有三种注释:
单行注释
单行注释只能写一行注释。由双斜线//组成,在双斜线后写注释。
//这是单行注释
多行注释
多行注释可以写一段注释,由/**/组成,在两个星号之间写注释,可以跨行写。
/*这是
多行的
注释
!!!!!*/
文档注释
文档注释一般写在类和方法的上一行,先写类和方法再写注释,描述类或者方法的作用。
/**
* 这个是⽂档注释,描述作⽤
* @author 作者
* @version 1.0.0
*/
提示:注释内容不能过多,也不能过少,核⼼逻辑⼀定要加注释,简单代码尽量不要加注释,⾃⼰衡量。