4.1 代码规范

编码原则

• 简明易懂，方便他人修改维护

• 编码规范，命名风格统一

• 适当明确的代码注释

适用原则

• 所有新代码、新类、新需求开发采用本套编码规范

• 对于老代码、老类上的小范围修改延续该类的原有风格以保持局部的代码格式一致性，后续重构逐步演进

规范用语与标签说明

• 可以、【参考】：表示允许操作

• 最好、【推荐】：最优的处理方式，非强制要求

• 一般：正常情况下按照规范执行，除非有特殊情况

• 必须：强制要求

• 没有以上用语的内容为强制要求

分语言的细则

ruby

• 必须 使用 Rubocop 进行代码格式化, 避免日后无意义的格式调整提交

• 参加 编码风格 https://github.com/JuanitoFatas/ruby-style-guide/blob/master/README-zhCN.md

• 推荐 使用 VisualStudio Code 或者 Atom 等开源 IDE, 方便分享插件

TODO: 参考 https://github.com/baixing/Law/blob/master/PHP-代码规范.md

TODO: 参考 https://github.com/baixing/Law/blob/master/百姓网程序员对待代码的基本原则.md