谈谈函数的命名规范

 最近在Review团队部分同窗的代码，梳理目前系统对外暴露的API状况，内心有一些感触，结合本身过去的一些心得体会，简单聊一下代码中函数或者API接口的命名规范。

1. 拼写要准确

不管是使用英文单词仍是拼音，必定要注意拼写的正确性，典型的错误例如“creatTime”，我确实不太能忍（即使我不是处女座）。特别是对外发布的API的名字命名，必定不能错，不然一旦发布就不方便改了，要保持兼容性。并且因为是提供给外部团队使用，拼写错误也会给使用者带来不便。

2. 使用正常的时态

这一点平时提到的人很少，可是我我的是比较看重的，特别是代码中状态的变量或者函数的命名，好比 onXxxxStarted 表示xxx已经启动了，isConnecting表示正在链接。正确的时态能够给使用者传递准确的信息。

3. 函数和属性的命名是有区别的

若是是函数，建议使用动宾结构

动宾结构就是 doSomething，这样的函数命名含义明确
好比： openFile, setName, addNumber...

若是是属性命名，建议使用定语+名词
好比 fileName, maxLength, textSize

5. 不要单词+拼音混合使用

好比：useJiFen，huKouNumber.. 缺少美感不说，可读性大幅度下降。

6. 谨慎使用缩写

除非是约定俗成已经被普遍使用的缩写，不然老老实实用完整拼写。
典型的反面例子: count->cnt, manager->mgr password->pwd button->btn
不管咱们使用eclipse 或者intellij, 都有很好的自动完成功能，名字长一点不要紧的，可读性更重要。

简单的说，咱们在命名的时候，须要站在使用者的角度去思考，API设计也要讲究用户体验。好的API设计应该是符合直觉，能望文生义的，让使用者能用尽可能简洁的代码完成调用。

扫描二维码或手动搜索微信公众号【架构栈】： ForestNotes