我们在编写代码时,不仅仅是要让自己看懂,也要让他人看懂,所以在编写代码的过程时,我们要用注释来标注某行某段或某篇代码的作用是干什么的,这不仅是让他人看懂你的代码,同时也是方便自己后面对代码的查看和调用。
注释:
注释就是解释说明的文字
可分为 // 单行注释; /*多行注释*/ 和 /**文档注释*/ 三种。
作用:对程序的解释说明,便于后期的维护。
原则:编写代码的过程中,要坚持注释先行的原则。
单行注释 //内容
作用域:单行有效
颜色:绿色
位置:行的上面 或者 行尾
嵌套:能嵌套单行,但不能嵌套多行或者文档
多行注释 /* 内容 */
作用域:多行内有效
颜色 :绿色
位置 : 类的上面或方法上面
嵌套 : 能嵌套单行不能嵌套多行|文档
文档注释 /** 内容 */
作用域 :多行内有效
颜色 : 蓝黑色
位置 : 类的上面或方法上面
嵌套 : 能嵌套单行不能嵌套多行|文档
多行与文档区别
1.文档注释内容能够被保留 在api文档(说明手册)中但是多行与单行不能
2.如果在idea。。等编辑工具中,在方法上添加文档注释会自带声明说明,而多行注释没有
注意:
恰当位置添加注释
注释内容不会被编译