有意义的命名

161 阅读1分钟

1 名副其实

变量、函数以及类的名称应该告诉你:(1)它为什么会存在(2)它做什么事情(3)应该怎么用

2 避免误导

别用accountList来指称一组账号,除非它真的是List类型,List一词可能会给程序员带来误解。

3 做有意义的区分

假如你有一个product类。如果还有一个productinfo类,或者productdata类,那么他们虽然名字不同,但意思却并无区别。

4 使用读的出来的名字

5 使用可以搜索的名字

6 避免使用编码

7 避免思维映射

不应该让读者把你的名称翻译为他们熟知的名称,这种问题经常出现在选择是使用问题领域术语还是解决方案术语时。

8 类名

9 方法名

10 别办可爱

11 每个概念对应一个词

给每个抽象概念选择一个词,并一以贯之。

12 别用双关语

13 使用解决方案领域名称

14 使用源自所涉问题领域的名称

15 添加有意义的语境

很好有名称是能自我说明的-多数都不能,你需要用良好命名的类,函数或者名称空间,给读者提供语境。如果没有这么做,给名称添加前缀就是最后一招了。

16 不要添加没用的语境