编码规范

出处不详，欢迎补充！

降低软件维护成本
在软件的整个生命周期中通常需要投入高额的维护成本。编码规范使不同工程师编写的代码具有统一的风格，提高了代码的可读性和可维护性，因此工程师们可以更快更彻底地理解代码。

提高软件质量
编码规范中明确地描述了在编码风格、原则、实践、方法以及经验等方面的要求和建议，切实地为如何提高软件质量指引了方向。

提高软件开发效率
编码规范作为代码集体所有的重要基础，可以帮助团队打破技术壁垒，促进知识共享。团队积极合作关注整体，有助于代码的重用，冗余的消除，在降低复杂度的同时减少浪费，提高开发效率。

McConnell描述了编码规范实践的理想状态，在开始编程之前建立编程规范。否则以后几乎不可能修改代码来匹配它们。在已有编码规范的前提下，仍要保持对编码规范的调整和优化。针对尚未制定编码规范的情况，推荐尽早制定。

可以结合以下几个方面参考业界的编码规范，然后结合自身实际情况进行裁剪或补充：
1、排版

• 符号的使用规则，如括号，制表符

• 缩进的使用规则

• 空行，代码逻辑的分段

2、命名

• 命名的基础规则，例如符合当前业务场景，命名易懂等

• 类、函数、变量等不同实体的名称的格式，例如驼峰等

• 名称的最大长度

3、注释

• 使用时机

• 格式

• 对注释的正确性、及时性的要求

4、编程原则举例

• 抽象原则

• 单一职责

• 里氏替换原则

• 开闭原则

• KISS原则

5、编程实践举例

• 代码评审

• 代码走查

• 重构

• 结对编程

• 测试驱动开发

• 持续集成

6、架构最佳实践

• 架构的选型

• 文件的组织

• 架构使用规范

7、常见问题举例

• 页面样式应写在css文件中

• 避免使用inline styles

编码规范内容确定后，应尽量将规则的目的与意义描述清晰，并且应对编码规范进行版本控制管理。编码规范作为编程的指导准则应受到尊重，每个工程师都应该严格遵守。

https://en.wikipedia.org/wiki/Coding_conventions#Common_conventions
https://en.wikipedia.org/wiki/Programming_style
https://en.wikipedia.org/wiki/Comment_(computer_programming)
https://en.wikipedia.org/wiki/Indentation_style
https://en.wikipedia.org/wiki/Characters_per_line
https://en.wikipedia.org/wiki/Naming_convention_(programming)
https://en.wikipedia.org/wiki/Coding_best_practices
https://en.wikipedia.org/wiki/Category:Programming_principles
https://github.com/google/styleguide