代码总体原则

1. 清晰第一
   清晰性是易于维护、易于重构的程序必需具备的特征。代码首先是给人读的，好的代码应当可以像文章一样发声朗诵出来。
   目前软件维护期成本占整个生命周期成本的40%~90%。根据业界经验，维护期变更代码的成本，小型系统是开发期的5倍，大型系统（100万行代码以上）可以达到100倍。业界的调查指出，开发组平均大约一半的人力用于弥补过去的错误，而不是添加新的功能来帮助公司提高竞争力。
   “程序必须为阅读它的人而编写，只是顺便用于机器执行。” ——Harold Abelson 和 Gerald Jay
   Sussman
   “编写程序应该以人为本，计算机第二。” ——Steve McConnell
   本规范通过后文中的原则（如头优秀的代码可以自我解释，不通过注释即可轻易读懂/头文件中适合放置接口的声明，不适合放置实现/除了常见的通用缩写以外，不使用单词缩写，不得使用汉语拼音）、规则（如防止局部变量与全局变量同名）等说明清晰的重要性。
   一般情况下，代码的可阅读性高于性能，只有确定性能是瓶颈时，才应该主动优化。
2. 简洁为美
   简洁就是易于理解并且易于实现。 代码越长越难以看懂，也就越容易在修改时引入错误。写的代码越多，意味着出错的地方越多，也就意味着代码的可靠性越低。因此，我们提倡大家通过编写简洁明了的代码来提升代码可靠性。
   废弃的代码(没有被调用的函数和全局变量)要及时清除，重复代码应该尽可能提炼成函数。
   本规范通过后文中的原则（如文件应当职责单一/一个函数仅完成一件功能）、规则（重复代码应该尽可能提炼成函数/避免函数过长，新增函数不超过50行）等说明简洁的重要性。
3. 选择合适的风格，与代码原有风格保持一致
   产品所有人共同分享同一种风格所带来的好处，远远超出为了统一而付出的代价。在公司已有编码规范的指导下，审慎地编排代码以使代码尽可能清晰，是一项非常重要的技能。 如果重构/修改其他风格的代码时，比较明智的做法是根据代码的现有风格继续编写代码，或者使用格式转换工具进行转换成公司内部风格。