在一个程序中,有意义的变量、函数或者类的命名有意义,能够顾名思义,非常重要。如果名称需要注释来补充,那就不算是名副其实。
对以上代码段的变量进行重新命名后得到以下代码段。
注意,以上的代码简洁性并未被触及,里边的运算符和常量的数量全然不变,只是修改了变量的名称,但代码变得明确多了。
避免误导:程序员必须避免留下掩藏代码本意的错误线索。别用accountList 来指称一组账号,除非它真的是List类型。提防使用不同之处较小的名称。误导性名称是可怕的,例如用小写字母l 和大写字母 O 作为变量,在代码中看起来会想常量 “1”和“0”,很容易混淆。
做有意义的区分:假设你有一个Product 类,另外还有一个ProductInfo或者ProductData类,那他们的名称虽然不同,意思却无区别。Info和Data就像a、an、the一样,是意义含混的废话。Variable一词永远不应出现在变量名中,Table一词永远不应当出现在表名中。
使用读得出来的名称:比较以下段代码
使用可以搜索到的名称:长名称胜于短名称,搜得到的名称胜于用自造编码代写就得名称。若变量或者常量可能在代码中多处使用,则赋其便于搜索到的名称。
1.类名和对象名应该是名称或者是名词短语,类名不应当是动词。而方法名应当是动词或者是动词短语。
2.函数名称应当是独一无二的,而且要保持一致。
3.避免将同一单词用于不同的目的,同一术语用于不同的概念。
4.添加有意义的语境,你需要用良好命名的类、函数或者名称空间来放置名称,给读者提供语境。如果没这么做,给名称添加前缀是最后一招了。但不要添加没用语境,只要短名称足够清楚,就要比长名称好。
第一写的博客。