“注释的目的是为了弥补代码自身在表达上的不足。”
这句话可以简单的理解为如果你的代码需要注释,最有可能是你的代码写的很烂。同样,如果在没有注释的情况下你无法用代码完整的表达你对一个问题或一个算法的思路,那这就是一个失败的信号。最终,这意味着你需要用注释来阐明一部分的思想,而这部分在代码里是看不出来的。好的代码能够让任何人在不需要任何注释的情况下看懂。好的编码风格能将所有有助于理解这个问题的所有信息都蕴含在代码里。
在编程理论中,有一个概念叫做“自我描述的源代码”。对于一段代码,一种常见的自我描述机制是遵循某种非严格定义的变量、方法、对象命名规则。这样做的主要作用就是使源代码更易读易懂。所以,也就更容易维护和扩展。
命名方法总结
概述起来,做为一个程序员,你应该:
- 命名是来表达概念的
- 注意名称长度,名称里只该含有必要的词语
- 编码规范有助于理解代码,你应该使用它
- 名称不要混用
- 名称在业务领域里要有意义,在上下文里有意义