为什么要编写注释?
- 为了更好的阅读自己编写的代码,建议添加这注释。自己写的代码,可能过一段时间回顾的时候,就变得不熟悉。这个时候,注释就起到了很好的帮助作用。
- 可读性第一,效率第二。一个软件一般都是一个团队协同作战开发出来的。因此,一个人写的代码,需要被整个团队的其他人所理解。
- 代码即文档。程序源代码是程序文档的重要组成部分。
注释的语法规则
单行注释:是最常用的注释方式,其注释内容从 //开始到本行末尾。
多行注释:注释内容放到 /*和 */之间。也即是,注释从 /*开始,到 */ 结束。
- tips:需要注意的是,多行注释 /*、*/ 不可以嵌套
文档注释:Java 语言提供了专门用于生成文档的注释。
- 文档注释是以 /** 开始,以 */结束的。