程序设计的代码风格(二)
命名风格
常量:全部大写
类名:大驼峰——首字母大写,其后单词首字母大写
方法函数名:小驼峰——首字母小写,其后单词首字母大写
变量名:小驼峰或下划线——全部小写,单词之间用下划线连接
系统保留:前置下划线( __ ),在命名中不要使用前置下划线
命名方法
在声明类的时候,把成员变量都声明为 private 的,这是一个很好的习惯。但是它在声明成员方法来操作私有变量时,却总是把方法命名得不伦不类。在一般的情况下,我们在操作类的私有变量时,会将给成员变量赋值的方法以 set 开头来命名,取私有变量的值的时候则是以 get 开头来命名。
对于bool类的方法,在命名的时候应当以 is 开头,来代表这是一个返回 true 或者 false 的方法。
注释
注释是计算机语言的一个重要组成部分,用于解释代码的功用,可以增强程序的可读性和可维护性。那么,需要注释什么呢?不要注释程序是怎么工作的,因为程序本身就应当能够说明这个问题。注释更多是为了解释程序做什么、为什么这样做。
在大多数的编程语言中,注释分为“行注释”和“块注释”两种。
行注释和块注释并不是语义上的“一行的注释”或“一大段的注释”,而是指语法中的意思。例如在 C++中, // 就是行注释, /* */ 就是块注释。
只有 种情况下可以使用块注释:
- 当我们需要把一大段代码注释掉的时候;
- 当自动化文档生成工具的语法要求使用块注释,或约定俗成使用块注释作为代码内文档的时候;
- 编程语言只有块注释语法的时候。
在其他情况下,我们建议永远都不要使用块注释。