introduce.md 1.3 KB

所谓无规矩不成方圆,不同时期不同开发人员写的代码可谓五花八门。 因此我们提出了一些相关代码方面的规范,希望日后能形成团队的编码规范。

制定开发规范的目的:

  • 统一团队的代码风格,减少代码冲突
  • 规范团队的开发流程,提高开发效率
  • 规范团队的协作方式,提高协作效率

规范准则

1. 一致性

代码风格应该是一致的,无论团队人数多少,代码应该同出一门。

不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

这样可以减少代码冲突,提高代码可读性。

2. 易于阅读

代码应该易于阅读,注释应该是清晰的,不应该有歧义。

3. 易于扩展

代码应该易于扩展,选择合适的设计模式,预留扩展点。

4. 易于维护

代码应该易于维护,业务逻辑与UI视图分离,模型清晰。

维护

不过我们也不确信风格指南的所有内容对于所有的团队或工程都是理想的。 所以根据过去的经验、周围的技术栈、个人价值观做出有意义的偏差是可取的。

如果你发现本规范中有任何错误,敬请指正。

如果你想要为这个规范做贡献或觉得有不合理的地方,请编辑后,提交 PR,进行讨论。