1、名副其实
变量、函数或者类的名称应该已经答复了所有的大问题。它应该告诉你,它为什么会存在,它做什么事,应该怎么用。如果名称需要用注释来补充,那就不是真正的名副其实。
2、避免误导
必须避免留下掩藏代码本意的错误线索。应该避免使用与本意相悖的词。特别要注意的是不要用字母l和o或者O来当变量名,因为他们和1、0太相像了。
3、做有意义的区分
如果缺少明确的约定,变量moneyAmount就与money没区别,customerInfo与customer没区别,accountData与account没区别,theMessage也与message没区别。要区分名称,就要以读者能鉴别不同之处的方式来区分。
4、用读的出来的名称
即不要起稀奇古怪的名字。
5、使用可搜索的名称
找MAX_CLASSES_PER_STUDENT很容易,但找到数字7就比较麻烦了。名称的长短应与其作用域大小相对应。
6、避免使用编码
无谓的成员前缀是没有意义的。
7、避免思维映射
不应当让读者在脑中把你的名称翻译为他们熟知的名称。
8、类名
类名和对象名应该是名词或名词短语,类名不应该是动词。
9、方法名
方法名应当是动词或者动词短语,属性访问其、修改器和断言应该根据其值命名,并加上get、set和is前缀。
10、别扮可爱
不要用俚语或俗语命名。
11、每个概念对应一个词
每个概念对应一个词,并且一以贯之。不要同一个概念在不同的类中有不同的描述。
12、别用双关语
避免将同一单词用于不同目的。同一术语用于不同概念,基本上就是双关语了。
13、使用解决方案领域名称
记住,只有程序员才会读你的代码。所以,尽管用那些计算机科学术语、算法名、模式名、数学术语吧。
14、