代码大全学习-14-变量名的力量(Power of Variables Names)

关注

原创最新推荐文章于 2017-11-27 14:42:11 发布 1.1k 阅读 AI 写同款· GEO 优化 ›

代码大全学习-34-自注释的代码(Self-Documenting Code) 说到注释，总是有争论要不要注释，有人喜欢尽可能多的注释，有人根本不写注释。作者的意见是适当的注释是需要的，但不要重复代码，不好的注释还不如不注释。总结性的，描述意图的注释是好的注释，它会告诉读者代码所没有提供的信息，是我们的目标。而另一大目标就是写出自注释的代码，无比清晰，根本不需要注释。这样可以大大节省读注释的时间，分析注释与代码是否一致的时间，从而提高效率。具体的方法有很多，篇阅读详情

这一章对变量名的讲述是相当的具体，作为一本手册真是名符其实。我不想在这里再重复那些具体详细的方法，可以去翻书，或者按照后面附上的checklist一条一条去检查。这里主要讲讲为什么要有那么多方法。

原因就是增强程序的可读性，从而降低程序的复杂性。所有的种种方法都围绕这一目的展开。像变量名要能准确完整的描述这个变量表示的内容，要描述它是什么(what)，而不是怎么做(how)，越具体越好，这样我们一看到变量名，就知道它是什么，增强可读性。再比如要制定一些命名规则，区分不同类型的变量，用什么样的前缀，用什么样的缩写，具体是什么样的具体分析，关键是要大家一起遵守，这样程序就会看起来像一个人写的，可读性大大增强。还有像要避免一些问题也都是为了方便阅读代码，理解代码。因为程序里全是各种各样的变量，变量的可读性好了，程序就容易看懂，复杂性就低，就不容易出错，维护性也好，质量就高。

相信这个原因有经验的同行都不存在什么疑问，直接附上checklist，要用的时候去查吧。

Checklist: Power of Variables Names

General Naming Considerations

Does the name fully and accurately describe what the variable represents?
Does the name refer to the real-world problem rather than to the programming-language solution?
Is the name long enough that you don't have to puzzle it out?
Are computed-value qualifiers, if any, at the end of the name?
Does the name use Count or Index instead of Num?

Naming Specific Kinds Of Data

Are loop index names meaningful (something other than i, j, or k if the loop is more than one or two lines long or is nested)?
Have all "temporary" variables been renamed to something more meaningful?
Are boolean variables named so that their meanings when they're True are clear?
Do enumerated-type names include a prefix or suffix that indicates the category-for example, Color_ for Color_Red, Color_Green, Color_Blue, and so on?
Are named constants named for the abstract entities they represent rather than the numbers they refer to?

Naming Conventions

Does the convention distinguish among local, class, and global data?
Does the convention distinguish among type names, named constants, enumerated types, and variables?
Does the convention identify input-only parameters to routines in languages that don't enforce them?
Is the convention as compatible as possible with standard conventions for the language?
Are names formatted for readability?

Short Names

Does the code use long names (unless it's necessary to use short ones)?
Does the code avoid abbreviations that save only one character?
Are all words abbreviated consistently?
Are the names pronounceable?
Are names that could be mispronounced avoided?
Are short names documented in translation tables?
Common Naming Problems: Have You Avoided...
...names that are misleading?
...names with similar meanings?
...names that are different by only one or two characters?
...names that sound similar?
...names that use numerals?
...names intentionally misspelled to make them shorter?
...names that are commonly misspelled in English?
...names that conflict with standard library-routine names or with predefined variable names?
...totally arbitrary names?
...hard-to-read characters?