一. 代码规范的重要性
有助于团队合作
减少BUG处理
降低维护成本
有助于代码审查
养成规范代码的习惯,有助于程序员自身的成长
毋庸置疑的是随着团队的发展、规范化,良好的代码规范能体现的好处会越来越明显,提升工作效率、提高代码质量等等…
二. 核心原则
原则一:代码应该简洁易懂,逻辑清晰
因为软件是需要人来维护的。这个人在未来很可能不是你。所以首先是为人编写程序,其次才是计算机:
不要过分追求技巧,降低程序的可读性。
简洁的代码可以让bug无处藏身。要写出明显没有bug的代码,而不是没有明显bug的代码。
原则二:面向变化编程,而不是面向需求编程。
需求是暂时的,只有变化才是永恒的。
本次迭代不能仅仅为了当前的需求,写出扩展性强,易修改的程序才是负责任的做法,对自己负责,对公司负责。
原则三:先保证程序的正确性,防止过度工程
过度工程(over-engineering):在正确可用的代码写出之前就过度地考虑扩展,重用的问题,使得工程过度复杂。
代码格式规范
命名规范
布局规范
注释规范