代码编程：（二）良好的命名规范

在编程过程中，我们随处都要进行命名。给变量，函数，参数，类，常量，类型，宏，包等。

命名一定要规范，良好的命名规范可以增强代码的可读性，易于他人和自己后期对代码的理解与维护。不规范的命名，甚至错误的命名，会增加他人理解代码的成本，甚至引起他人包括自己对代码的误解。自己就曾经有同事把“delegate”单词错拼成了“delete”从而导致另外一名同事纠结了一个下午。

怎么做到良好的命名规范：

1 命名要“名副其实”：

要做到通过名字，就知道变量为什么存在，在做什么事情。一旦发现更好的更合适的命名，不要犹豫，马上更换。如果一个命名需要用注释进行补充说明，表明这个命名不算“名副其实”。

比如：

int i; //用来循环数组的下标索引

哪怕加了注释，依然是很不好的命名，在其他位置遇到i，会很困惑，甚至可能需要跳到这里看注释，增加了代码“模糊度”。

2 命名要“避免误导”

千万不要把“英语差”作为糟糕代码的挡箭牌，要知道写代码不仅仅是给自己看的，也是给其他人看的。

要做的命名单词无拼写错误。一定要做到。

不要占用系统已有的专有词汇命名。每种编程语言，都会警告大家，不要这样做，甚至最好不要让这些专业词汇轻易出现在自己的命名中。

避免词汇外形误导，比如l(小写的L字母)和1（阿拉伯数字1），o（小写字母O）和0 (阿拉伯数字0)

3 作出“有意义的区分”

比如定义一个函数拷贝字符串

void copyString(char str1[], char str2[]);

str1和str2简单使用数字命名的方式，在这个方法中就显得很有误导性，让人看了分不清str1和str2的区别，谁是被拷贝的字符串，谁是拷贝以后的字符串。

如果改成source和destination进行区分，就会一下子明朗很多

void copyString(char source[], char destination[]);

假如一个项目定义了下面一些类

class Product;

class ProductData;

class ProductInfo;

info，data，a，the，an,在某些地方是意义含混的废话。

variable不该出现在变量名中，Table不该出现在表名中，nameString不见得比name清晰多少。

4 尽量使名字“读得出来”

OC刚出来的时候，被称作一门很“优雅”的语言，其中有个特点，读OC的官方代码，函数的名字就是一句话，写代码如同写作文。

不要用自创的单词和语句。

5 多使用“可搜索的名字”

面对数字常量，多使用宏或者枚举定义，不要直接在代码中使用数字。数字是很难看出含义的，后期维护很麻烦。

6 前缀的区分

很多时候，项目需要引入第三方库，需要和第三方公司合作；保持类名，包名的特殊性，能够避免命名冲突。