java入门 - 规范你的代码注释

java基础语法-代码注释

注释只是为了提高可读性，不会被计算机编译。代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。

开发中注释可以分为三种方式：

• 行注释
• 块注释
• 类/方法注释。

行注释

行注释是对一行代码进行注释，ide工具(idea/eclipse)可以使用ctrl+/ 快捷键进行快速对选中的行注释。最常见的使用场景是在方法内注释某个属性或某块区域的含义。

块注释

块注释是对多行注释的一种方式。一般用在多行内容进行注释说明。

类方法注释

此类注释一般用在类的说明，方法说明上。注意与块注释不同第一行有两个*号。

很多公司还对公司开发中的注释给出了严格的规范，大家进入公司后先看看之前同事的代码，学习他们的注释规范。这样能够快速融入团队。