8.13-注释有哪几种形式?
8.13-注释有哪几种形式?
小uava 中的注释有三种:
Java 注释类型总结
- 单行注释:通常用于解释方法内某单行代码的作用。
- 多行注释:通常用于解释一段代码的作用。
- 文档注释:通常用于生成 Java 开发文档。
用的比较多的还是单行注释和文档注释,多行注释在实际开发中使用的相对较少。
在我们编写代码的时候,如果代码量比较少,我们自己或者团队其他成员还可以很轻易地看懂代码,但是当项目结构一旦复杂起来,我们就需要用到注释了。注释并不会执行(编译器在编译代码之前会把代码中的所有注释抹掉,字节码中不保留注释),是我们程序员写给自己看的,注释是你的代码说明书,能够帮助看代码的人快速地理清代码之间的逻辑关系。因此,在写程序的时候随手加上注释是一个非常好的习惯。
《Clean Code》这本书明确指出:
代码的注释不是越详细越好。实际上好的代码本身就是注释,我们要尽量规范和美化自己的代码来减少不必要的注释。
若编程语言足够有表达力,就不需要注释,尽量通过代码来阐述。
举个例子:
去掉下面复杂的注释,只需要创建一个与注释所言同一事物的函数即可
1
2 // check to see if the employee is eligible for full benefits
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))应替换为
1 if (employee.isEligibleForFullBenefits())