最近在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
网友评论