变量名中常用的对仗词
特定数据类型的命名
循环下标命名
简单循环变量名用i、j、k,嵌套循环用teamIndex、eventIndex更具有描述性的变量名。
状态变量命名
状态变量命名不要出现flag,最好用枚举变量、具名常量或用作具名常量的全局变量来赋值。
临时变量命名
用真正的变量来代替临时变量。(其实不存在临时变量的说法,所有的变量都算是临时的)
布尔变量命名
列出几种典型的布尔变量命名
- done 表示某件事情已经完成,可用于表示循环结束或一些其他的操作已经完成,完成之前设为false,完成之后设为true。
- error 表示有错误发生,错误发生之前设为false,错误已经发生时设为true。
- found 表明某个值已经找到了,没找到该值的时候设为false,一旦找到该值设为true,如查找数组中的某个值。
- success或ok 表明一项操作是否成功,操作失败的时候设为false,操作成功的时候设为true,但尽量用具体的名称代替。如果完成处理代表这个程序成功,可以用processingComplete代替。
给布尔变量赋予隐含“真/假”含义的名字,如把status替换为error或者statusOK、把sourceFile替换为sourceFileAvailable或者sourceFileFound。
Is+状态的命名方法能确保名称不是毫无意义的,但降低的逻辑的可读性。
使用肯定的布尔变量名,否定的如notFound,在取反的时候你会很头疼。
枚举类型命名
在C#里面枚举数据自带前缀(如Color.Red),枚举元素命名不用带前缀,只需要注意命名首字母大写即可。
常量命名
常量命名根据表示的含义命名,不要基于数值如Five。