《Clean Code》之有意义的命名
1. 名副其实 选个好名字要花时间,但省下来的时间比花掉的多 一旦发现有更好的名称,就换掉旧的 2. 避免误导 避免留下隐藏代码本意的错误线索 避免使用与本意相悖的词 如:不用accountList来指代一组账号,出非它真的是List类型 3. 做有意义的区分 命名并不仅仅只是为满足编译器的需要 如:一个ProductInfo类和ProductData类,它们名称虽然不同,意思却无区别。 4. 使用读得出来的名称 不要随意自造词 5. 使用可搜索的名称 长名称胜于短名称,搜得到的名称胜于用自造编码代写的名称 单字母名称仅用于短方法中的本地变量 名称长短与其作用域大小相对应 6. 避免使用编码 匈牙利标记法(HN) 在现代编译器的情况下,已经过时了 成员前缀 应当把类和函数做得足够小,消除对成员前缀的需要 接口和实现 接口的前导字母I被滥用。通常并不想让用户知道提供使用的是接口 7. 避免思维映射 不应当让读者在脑中把你的名称翻译为他们熟知的名称 这种问题经常出现在选择是使用问题域术语还是解决方案领域术语时 8. 类名 类名和对象名应该是名词或名词短语 类名不应当时动词 9. 方法名 方法名应当是动词或动词短语。属性访问器、修改器和断言应该根据其值命名,并可加上get、set和is前缀。 10. 别扮可爱 切忌华而不实!言到意到! 11. 每个概念对应一个词 给每个抽象概念选一个词,并且一以贯之 12. 别用双关语 避免将同一词用于不同目的 同一术语用于不同概念,就算是双关语了 13. 使用解决方案领域名称 使用计算机科学术语,尽量不使用用所涉领域名称来命名。因为只有程序员会读你的代码。 14. [...]
浙公网安备 33010602011771号