《代码整洁之道》-- 写代码时需要注意的命名技巧

最近在看《代码整洁之道》这本书，感觉这本书不错，其主体思想就是代码质量与其整洁度成正比。而具体如何量化代码的整洁度正是书中所讲。学习之余，整理了一下书中内容和作者思想，在此记下一些笔记并加上一些自己的理解和看法，希望通过记下这些加深学习和理解，更方便自己日后温故知新，同时分享给希望改善或提高自己编码质量的朋友们

这篇文章是对书中关于写代码时需要注意到的各种命名技巧进行总结，如下：

 

1.名副其实 

变量、函数或类的名称会告诉你很多东西，选择体现本意的名称让人更容易理解和修改代码。该告诉你它为什么会存在、它做什么事、应该怎么用。如果名称需要注释来补充，那就不算名副其实。 

比如：int aList<int[]> 、list4 这些命名，

但要注意一些特殊情况，比如在作用域较小、也没有名称冲突时，循环计数器自然有可能被命名为i或j或k，这是因为传统上惯用但字母名称做循环计数器。

 

2.避免误导 

2.1命名留下与代码本意相悖的错误线索

如 accountList命名一组账号，然而其并非用List存储

2.2防止使用不同之处较小的名称

如 XYZControllerForEfficientHandlingOfStrings 和 XYZControllerForEfficientStorageOfStrings

2.3尽量避免使用小写字母l 和大写字母O作为变量名 ，易与数字1和0混淆

 

3.不做无意义的区分

针对在同一作用范围内的两样同类型数据，命名时进行如下无意义的区分：

3.1数字系列命名 如：a1、a2、a3…aN

3.2废话信息命名 如：假如有个Product类，ProductInfo 和 ProductData 以及a、the这样的前缀

 

4.使用可搜索的名称

名称长短应与其作用域大小相对应，若变量或常量可能在代码中多处使用，则应赋予其便于搜索的名称。

比如：全局变量WORK_DAYS_PER_WEEK 要比sum好找的多

 

5.匈牙利命名法

这一种编程时的命名规范。基本原则为：变量名 = 属性 + 类型 + 对象描述

虽然我们平时编程时不需要严格按照此规范命名，但了解此规则可方便我们对一些源码及库文件工程的代码的理解，增加可读性。

5.1属性部分 ：g_ 全局变量 、c_ 常量 、m_ c++类成员变量、s_ 静态变量

但是，我们平时写代码时应该尽量把类和函数做得足够小，消除对成员前缀的需求。

5.2类型部分：数组a、指针p、函数fn、无效v、句柄h、长整型l、布尔b、浮点型f、字符串sz、字符ch、整型i、字节by等

5.3描述部分：最大Max、最小Min、初始化Init、临时变量T、源对象Src 、目的对象Dest等

 

6.类名、对象名与方法名

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

方法名应该是动词或动词短语，属性访问器、修改器和断言应该根据其值命名，并加上get、set和is前缀。

 

7.每一个概念对应一个词

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

比如：fetch、retrieve和get来给多个类中的同种方法命名就是错误的，同理还有一会使用controller，一会用manager、driver等。

 

以上。