代码整洁之道----命名规范

1、变量、函数或类的名称要体现出:它为什么会存在、做什么事、应该怎么用。
2、避免使用与本意相悖的词
3、做有意义的区分:比如ProductInfo或ProductData类,虽然名称不同但是意思无区别。废话都是冗余。Variable一词永远不应当出现在变量名中。Table一词永远不应当出现在表名中。
4、使用读得出来的名称。程序里面写了个genymdhms(生成日期,年、月、日、时、分、秒),他们一般读作“gen why emm dee aich emm ess”,这样子很多设计师和分析师都有样学样,听起来傻乎乎的。
5、使用可搜索的名称。长名称胜于短名称。如变量或常量可能在代码中多处使用,则应赋其以便于搜索的名称。
6、避免使用编码。接口和实现。ShapeFactor是个接口,那么我们对应的实现类写ShapeFactoryImp或者CShapeFactory比写IShapFactor更好。
7、避免思维映射。专业程序员了解,明确是王道。专业程序员善用其能,编写其他人能理解的代码。单字母变量名,在作用域较小、也没有名称冲突时,循环计数器自然有可能被命名被i或j或k(但是千万别用l),这是因为传统上惯用单字母名称做循环计数器。然而,在多数其他情况下,单字母名称不是个好的选择。
8、类名和对象名应该是名称或名称短语。类名不应当是动词。
9、方法名 应当是动词或动词短语。属性访问器、修改器和断言应该根据其值命名,并依javabean标准加上get、set和is前缀。可以考虑将相应的构造器设置为private,强制使用这种命名手段。
10、命名不要使用俗语或俚语。
11、每个概念对应一个词,并一以贯之。
12、别用双关语,避免将同一单词用于不同目的。
13、尽量用计算机科学术语、算法名、模式名、数学术语。
14、如果不能用程序员熟悉的术语来给手头的工作命名,就采用所涉问题域名领域而来的名称。优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。
15、添加有意义的语境,只要短语足够清楚,就比长名称好。比如GSDAccountAddress这17个字母里面,有10个字母纯属多余或者与当前语境毫无关联。对于Address类的实体类来说,accountAddress就是一个不错的选择。



* 以上内容是看《代码整洁之道》[美·马丁] 第二章的总结

你可能感兴趣的:(代码整洁之道)