如何写出优雅的代码—变量名使用

发布于 2021-02-21  840 次阅读


良好的编程习惯从准确,有效,容易辨别的变量名定义开始;

最重要的注意事项

该变量名要完全,准确地描述出该变量所代表的事物;

以问题为导向;

最适当的名字长度;(10到16)

变量名对作用域的影响:短变量名一般适用于循环或局部,代表作用域十分有限;

限定词加到最后:expenseTotal,revenueTotal;具有优雅的对称性;

特定类型的数据命名

为循环下标命名

i,j,k只用于循环当中,如果作用范围比此大,请使用其他命名;

为状态变量命名

应当直接读懂,而非简单的flag,如isOpendoor;

为临时变量命名

临时变量也应该提供信息,如temp则无法表示具体意义,改为Combined(合);

为布尔变量命名

done,error,found,success;

注意,不要使用否定的布尔变量 如notOpen,可读性差且需要双重否定;

为枚举类型命名

使用前缀标明为一个组,如Color_red,Color_blue;

为具名变量命名

应该使用其意义,而非其数字,如CYCLES_NEEDED比FIVE好;

命名规则的作用

要求你更多的按规则行事,通过做一项全局决策而不是多次局部决策,你可以集中精力关注其他的事情;

有助于阅读项目代码和其他人的交流;

有助于学习新的代码项目;

有助于减少名字增生;

弥补编程语言的不足之处;

强化相关变量之间的关系;

总结:规则为你的代码增加了结构,减少了你要考虑的事情

变量命名指导原则

在代码里缩写对照表来解释变量含义;

编写一份标准文档;

应当避免的名字

避免使用令人误解的名字和缩写;

避免使用具有相似含义的名字,如input和inputValue;

避免使用拼写相近的名字,如gad和good;

避免使用发音相近的名字;

避免在名字中使用数字;

避免拼错单词;

避免使用多种语言标准;

避免使用关键字作为名字,如 if  if then then;

要点

对于变量的命名要多加考虑;

名字要尽可能的具体;

命名规则应该可以区别局部数据,类数据,和全局数据;

名字应该方便阅读!!!


她喜欢所以就做咯