代码规范也叫编程规范,是指对编码相关的行为做出一系列约定,包括文件组织、代码格式、函数注释、变量命名等。使项目易于管理的方法之一就是加强代码的一致性,让团队中的成员可以快速读懂其他人的代码。保持统一的编程风格意味着可以很容易根据一些规则来推断出各种代码的含义。创建通用、必须的习惯用语还可以让代码更容易被理解。
根本原则
- 避免风格争论:如何格式化代码并没有正确的答案,但在团队项目中,一致性很重要。
- 易读而非易写:通常情况下,代码被编写一次,而被阅读多次、修改多次。因此值得花费稍长的时间编写代码,以获得更好的阅读性。
遵守代码规范的好处
遵守代码规范可以增加代码可读性、减少维护成本、改善工作流程、促进团队协作以及提升自身成长等等。举例来说:
增加代码可读性
代码规范对可读性有巨大的提升。当团队遵守相同的规范时,在阅读他人代码时就像在阅读自己代码一样。同时规范的代码也有助于同事(包括新入职的同事)尽快理解代码意图。
// × 不好:可读性不佳,需要掌握运算顺序才能理解等号后的表达式
var a = b && c || d && e;
// √ 好的:绝大多数程序员都能理解
var a = (b && c) || (d && e);
减少维护成本
几乎没有任何一个模块,在项目的整个生命周期中,都由最初的开发人员来维护。代码的可读性提高后,新的维护人员可以更快地理解代码,使维护成本降低。
改善工作流程
// × 不好:当新增枚举时,需要在 Tue 之后增加逗号,svn 的提交记录会受到影响。
enum Day
{
Sun,
Mon,
Tue
};
假设 Tue
由 A 提交,之后 B 需要为其新增一个 Wed
枚举:
enum Day
{
Sun,
Mon,
Tue, // B 需要在此新增一个逗号,该行的提交者会变为 B。
Wed,
};
正确的做法:
enum Day
{
Sun,
Mon,
Tue, // 即使是结尾的枚举值也需要加上逗号。
};
促进团队协作
当遵守代码规范时,文件名、类名、方法名甚至变量名都是可预测的。如果所有的数据管理类都以 Controller
结尾,当一名程序员需要找到 PlayerData
对应的管理类时,他可以直接打出 PlayerController
,而不用去查文档或者询问 PlayerData 的开发人员。
由此可见,当遵守代码规范时,团队之间会形成一种无声的默契。
提升自身成长
规范的代码可以有效提升程序员的代码组织能力,写代码时条理会更清晰、逻辑思维也会更强。
遵守代码规范的坏处
大部分东西都有两面性,代码规范也不例外。在遵守代码规范时也有一些坏处或者说难处:
- 对团队来说:代码规范需要所有人都遵守规则,可能难以在团队中推行。
- 对个人来说:个人的代码习惯较难改变。在遵守团队规范时,个人的风格得不到表现。
代码规范与性能取舍
部分程序员可能会担心一些规范对代码的性能有影响,如 ++i
比 i++
的性能更好。但这种担心在绝大部分情况下都是多余的,代码规范并不会对性能有多大影响,或者说造成性能瓶颈。代码规范与更好的性能,两者通常并不会冲突。
少数情况下,确实对性能有影响的,也可以不遵守代码规范,但这种情况下需要补充更完善的注释以及为何这样去写的说明。
标签:可读性,代码,规范,必要性,遵守,团队,Tue From: https://www.cnblogs.com/comradexiao/p/18467036