优秀的开发者从命名开始

最新推荐文章于 2021-07-12 21:07:23 发布

寒冰屋

最新推荐文章于 2021-07-12 21:07:23 发布

阅读量248

点赞数

分类专栏：管理/方法/理论文章标签：命名规则

版权

174 篇文章 1 订阅

订阅专栏

有人说，命名能力也能体现一个程序员的基本编程素养。我很赞成这句话！作为开发人员逃不过起名字这一关的,大到项目名、模块名，小到类名、方法名、参数名、参数名、变量名。而命名又对代码的质量和可读性起到很关键的决定。

如何码出高质量的代码呢？其实命名也没有那么难，关键看你重不重视，愿不愿意花时间。以下是课程笔记和阿里巴巴的开发手册中觉得适用的部分，分享出来。

课程笔记

命名的一个原则能够准确的表达其含义即可。命名可以长点也没关系。

这里说的可读，指的是不用用一些特别生僻的英文单词来命名。可搜索是利用开发工具的智能联想功能。比如键入获取某个对象“.Get”,IDE就会返回所有以Get开头的方法等等。例如：

一个函数几百行，说明了什么？逻辑过于复杂、阅读代码的时候，很容易就会看了后面忘了前面。其实更能反映一个程序员的逻辑能力和提炼能力！要本着函数单一职责原则，进行合理的拆分！具体函数大小也没法量化，网上有一种说法，那就是不要超过一个显示屏的垂直高度。大概函数也是50行左右。

注释如何写？命名很重要，注释跟命名同等重要。有人认为好的命名完全可以代替注释。个人觉得，这样的观点有点太过极端。命名再好，毕竟有长度限制，不可能足够详尽，这个时候，注释就是一个很好的补充。注释的目的是让代码更容易看懂。

阿里开发手册命名、注释部分（稍有改动）

【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
【强制】类名、方法名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / UID 等。
【强制】参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
【强制】杜绝完全不规范的缩写，避免望文不知义。反例：AbstractClass“缩写” 命名成 AbsClass；condition“缩写” 命名成 condi，此类随意缩写严重降低了代码的可阅读性。
【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。

注释规约

说明：对子类的实现要求，或者调用注意事项，请一并说明。

【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

最后，还有一条非常重要的，那就是，项目、团队，甚至公司，一定要制定统一的编码规范，并且通过 Code Review 督促执行，这对提高代码质量有立竿见影的效果。