"温故而知新，可以为师矣" -- Dr.孔夫子
在做过第三次有关命名的分享后，我决定将命名的方法更新一下。
前情回顾
上一篇，我们说了给函数或者变量命名的几种基本方法，总结如下：
- 基于已有认知。如果在领域里已经有一些约定俗成的函数命名，最好直接拿来用。
- 尽量反映函数的通用性。
- 能望文生义。好的命名应该一目了然，而且针对不同的情况应该做不同的命名。
- 由句到词。遇到不知道改怎么命名的函数，先用一句话将函数描述出来，再逐渐提炼、精简句子结构，最终提炼出函数名称。
- 类比、联想。如果找不到合适的词语，可以采用类比、联想等方式，形象的表述一个函数的含义。
- 易于理解。尽量不用一些容易造成误解的词语。
大家在编码或者读代码的过程中，对于什么样的命名是好的命名可能认知不是特别清晰，但是对于什么样的命名是坏的命名应该一目了然，他们包括：
命名里哪些是禁忌
- 拼音。 拼音是命名中万恶之首。大家对于程序的固有认知是它是基于英语系的命名标准，所以如果用拼音、甚至拼音缩写，会让读代码的人一头雾水，无从下手。比如我曾经读到过类似于“CXF”、“MDD”等命名的变量，如果我不告诉你它们是“磁悬浮”、“目的地”，估计永远猜不到。所以用拼音命名是非常不推荐的。当然如果有条件的话，用中文(注意是中文，不是拼音)做变量名我觉得也可以，比如易语言或者Swift。
- 数字。 我个人的经历可以说明，数字完全可以避免。即便是同一类食物，也可以通过细致的描述加以区分，而不是用数字来区分。例如button1，button2可以改成upperButton，lowerButton。而且一旦使用数字进行命名，后续如果需要修改控件顺序会发生灾难，就需要人为建立button1是第二个button的怪异映射。
- 含义错误。 这个经常发生在单词量少的同学身上。例如将桌子命名为椅子这种错误，是可以通过查看字典避免的。但是这里要说明的是，觉不要单单通过字面意思来查字典，请看这个单词或者词组在例句中是不是想要的意思，而且最好参考大公司或者著名文章的选词，而不是网络文章的选词。
- 保留字。 使用保留字而造成的bug是我遇到的最难以察觉的bug之一，原因是人们很难察觉到命名不当会产生bug。实际上，以iOS为例，如果使用get或者set作为函数命名的前缀时，系统会默认你在override某个变量的getter和setter方法，此时如果恰好你的类中有对应的变量时，变量的读写很有可能会出现使用问题。
- 混搭。 目前比较流行的命名规则有驼峰命名以及下划线命名等。个人认为一个项目中，要么统一使用驼峰命名，要么统一使用下划线命名，但是不要混搭。个人认为iOS项目中使用驼峰比较多，前端项目中（js）使用下划线比较多。
说了不少大家在编码时候的坏习惯，也顺便说下自己在编码时的好习惯以及方法，供大家参考。
命名应该遵循的规则
- 具体。命名时，我认为第一要具体。具体指的是可以一目了然的知道其所指代的含义。例如在一个复杂的视图结构中，应该明确的命名confirmButton跟cancelButton而不仅仅命名为button。
- 精简。如果在环境，或者上下文清晰的条件下，命名越精简阅读成本越小，编写调用过程中也会越流畅。例如在只有一个Button的View结构中，按钮可以命名为button，因为上下文决定了这个button是唯一的。
- 使用固定的组合结构，例如表示事物用名词或者名词+名词，表示动作用动词或者动词+宾语。这个组合可以通过上一篇文章里Mathematica的命名结构分析里可以看出来。
- 对函数来说，先解构，再命名。有时候函数难以命名是因为它被赋予了太多功能。例如一个函数如果既做了初始化，又做了布局，还做了事件处理，当然命名时会很崩溃。因此这种情况，要先把这个函数拆分为三个子函数，初始化子函数、布局子函数、事件处理子函数，然后再逐一命名。
- 参考权威。必要时，可以去参考下权威的SDK或者API的函数命名，跟着权威的思路和方法走走不会出错。具体会在下文给出示例。
- 注释。如果真的不想花时间思考命名，那至少请给出注释。不然一旦有一天你的同事帮你处理这段代码的时候会死伤无数脑细胞。
案例分析
这里我们来分析并总结一下苹果的iOS的SDK命名规则是怎样的。(本章节中所有命名来源于苹果SDK)
- UI控件：功能描述+类型，例如
menuButtons - 常量：描述对象+类型，例如
rowHeight - 文件名：通常会加前缀，例如
UIButton - 通知：前缀+对象+（助动词）+宾语+Notification ，例如
UIMenuControllerDidShowMenuNotification - 代理：前缀+对象+Delegate,例如
WKNavigationDelegate - 协议：对象+（助动词）+动作+宾语，例如
tableViewdidEndDisplayingFooterView - 枚举：定义好枚举名之后请将所有成员加上该名称作为前缀，中间不要加下划线，例如
UITableViewStylePlain , UITableViewStyleGrouped
命名是一个很困难的过程，即便这些理论和方法我已经很熟悉，但是在日常的编码时还是会遇到各种各样的困难。大家有遇到命名困难的时候可以多和身边的同事讨论，当然也欢迎留言和我进行讨论，一起为写出简单易懂的代码而努力。
希望小文能帮助对各位朋友的工作与学习起到帮助的作用。：）
网友评论