代码整洁之道

Posted 2021-02-19 一颗遗失的星星

有意义的命名

1 名副其实

2 避免误导

3做有意义的分区

废话都是冗余。Variable永远不应出现在变量名中，Table一词永远不应出现在表名中。

当缺少明确约定：变量moneyAmout与money没区别，customerInfo与customer没区别，accountData与account没区别，theMessage与message没区别。

4 使用读得出来的名称

5 使用可搜索的名称

使用常亮代替数字会比直接使用数字更利于搜索。比如WORK_DAYS_PER_WEEK比数字5要好找得多，也体现出数字5的含义。

6 避免使用编码

不要使用前缀，比如m_这样的

接口和实现
如果你做一个创建形状用的抽象方法(AbstractFactory)，不要使用IShapFactory这样的，去掉I，直接使用ShapFactory，直接告诉读者这是一个ShapFactory

7 避免思维映射

如for循环中，只用i，j，k，不要使用其他如l这样的字母

明确是王道

8 类名

类名和对象名应该是名词或名词短语。

9 方法名

方法名应当是动词或动词短语。
重载构造器时，使用描述了参数的静态工厂方法名。如
Complex fulcrumPoint = Complex.fromRealNumber(23.0);
要比直接new Complex(23.0)要好得多

10 每个概念对应一个词

给每个抽象概念选一个词，并且一以贯之。

比如，使用fetch、retriever和get给多个类中的同种方法命名。

11 别用双关语

避免将同一单词用于不同目的。

12 使用解决方案领域名称

需要给一些场景取些技术性的名称。

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

如果并不能用程序员熟悉的术语解决手头的工作命名，就使用源自所涉问题领域的名称。

14 添加有意义的语境

如果某些变量是一个大结构的一部分，就把这个大结构的名称作为每部分的前缀。比如地址有国家，省份，市区。如果它们代表一个地址，就把addr添加到它们的前缀中。

当然，也不要添加没有意义的语境。

15 最后

取好名字最难的地方是需要良好的描述技巧和共有文化背景。

我们有时会害怕其他开发者反对重命名，如果讨论一下，这样的反对可能就会被消除，如果名字改的足够好，大家也会很感激你。

函数