## **引自《阿里规约》的开头片段：** ~~~ > 现代软件架构的复杂性需要协同开发完成，如何高效地协同呢？ > 无规矩不成方圆，无规范难以协同，比如：制订交通法规表面上是要限制行车权，实际上是保障公众 > 的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不 > 是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升 > 协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜 > 绝踩重复的坑，切实提升系统稳定性，码出质量。 ~~~ * * * ## **前言** 开源的代码是基于阿里巴巴、华为的开发规范手册，同时添加了我们公司团队自己风格和规范，补充了一些细节。 * **规范不是为了约束和禁锢大家的创造力，而是为了帮助大家能够在正确的道路上，尽可能的避免踩坑和跑偏。** * **规范可以让我们无论单枪匹马还是与众人同行的时候都能得心应手。** * **规范可以让我们在面对日益变态的需求和做代码接盘侠的时候，更优雅从容。** * **规则并不是完美的，通过约束和禁止在特定情况下的特性，可能会对代码实现造成影响。** * **我们制定规则的目的：为了大多数程序员小伙伴可以得到更多的好处，如果在团队实际运作中认为某个规则无法遵循或有更好的做法，希望大家可以共同改进该规范。** * * * ## **基础规范** ### 什么是好的代码？ * **满足业务需要：代码是来实现业务的，如果业务都实现不了，代码也就没什么价值了！** * **代码尽可能的清晰明了：就是让小白也能看懂你的代码！** * **代码尽可能的少：在保证清晰明了的前提下，能少一行少一行，能少一个类少一个类！** * **代码尽可能复用性和模块化：在保证清晰明了和尽可能少的前提下，能复用的代码尽量复用，能模块的尽量模块！** 以上四个原则的重要程度依次降低， 这是我们认为好代码的原则，即：简单的、好的、代码。 * * * ## **注释规范** ### 注释和代码一样重要 注释是我们披荆斩棘历经磨难翻越需求这座大山时，留下的踪迹和收获的经验教训，这些宝贵的知识除了证明我们曾经存在过，也提醒着后来的人们殷鉴不远、继往开来。 注释除了说明作用、逻辑之外。还有一个很重要的原因：当业务逻辑过于复杂，代码过于庞大的时候，注释就变成了一道道美化环境、分离与整理逻辑思路的路标。这是很重要的一点，它能有效得帮助我们免于陷入代码与业务逻辑的泥沼之中。 * * * ## **无用代码：删！** 因为现在所有的项目都使用了代码管理工具，比如 git、svn 等，所以对于无用的代码，让我们尽情的删除掉吧！ 重要的说三遍： 不要注释代码，不要注释代码，不要注释代码！ 要删除代码，要删除代码，要删除代码！