转载

编写高质量代码(下)

上回从微观角度，以一个实际的例子，从正确、高效、易读等特性着手，介绍了如何编写高质量的代码。这次，我们从宏观出发，从软件开发流程入手，着重介绍其中的几个方面，包括代码规范、Code Review、测试等

代码规范

团队的代码规范，一般由领导和大佬们制定后，大家统一实行。这里面有几个问题：

真的需要代码规范吗？

言下之意，制定和执行代码规范是否浪费时间？

答案是：It depends。如果项目很庞大、代码质量要求很高，那么，制定和执行代码规范所花费的时间，将大大少于后期因为不规范开发带来的种种调试和维护成本。如果是小打小闹的代码，就无所谓了。

代码规范的制定为什么这么难？

原因众多，其中一个很重要的部分是大佬众多，大家的口味和风格不同。就代码风格而言，有人喜欢对内置类型变量i使用i++，有人坚持认为应该使用++i不管i是不是复杂类型。因此，制定代码规范需要在讨论之后最后拍板决定，这里面甚至需要独裁！是的，独裁！

代码规范制定需要注意什么事项？

如果代码规范限制太松，那么等于没有规范；如果太严，大大影响开发效率。这里面的尺度，需要根据项目需要、团队成员特点全面考量，进行取舍。

需要注意的是，没有任何一种代码规范是完美的。例如，在C++中，如果启用异常，那么代码的流程将会被各种异常处理中断，各种try catch throw让代码很不美观；如果禁用异常，也就是在开发的过程中不能使用异常特性，那么团队成员可能因为长期没有接触这项语言feature而造成知识和技能短板。

代码风格举例

举两个我认为比较重要、比较新鲜、比较有趣的代码风格。

1，使用引用需要判空吗？

void f(int &p); void g(int *p);

我们都知道，在g中，使用*p前需要对p是否为NULL进行判断，那么f呢？如果质量非常关键、代码安全非常重要对场景，那么实际上，也是需要的。因为调用者可能这样：

int *q = NULL; //...... f(*q);

因此，需要在f里增加 if(NULL == &p) 的判断。

2，级联if else语句。

首先看一个我个人认为不好的代码风格：

int f(int a, int b) {   if (a >= 1) {     if (b >= 1) {       if (a >= b) {         //do sth       } else {         //error1       }     } else {       //error2     }   } else {     //error3   } }

这个函数的核心在于do sth部分。其实我们可以改写为级联if－else形式，如下：

int f(int a, int b) {   if (a < 1) {     //error3   } else if (b < 1) {     //error2   } else if (a < b) {     //error1   } else {     //so, a>=1 && b>=1 && a>=b     //do sth   } }

是不是优美多了？前面只做一些错误处理、前期准备、参数检查等，最后的else分支做实实在在的功能性事情。

Code Review

什么是Code Review？

很多人把它翻译为代码审查，我觉得太政治味了。程序员尤其是新手写完代码后，可能会有风格问题（比如不符合团队的代码规范）、安全性问题(比如忘记指针判空)、优雅性问题(比如大量多余代码)、正确性问题（比如算法设计错误），那么在发布代码到公共库之前，提交给师兄或者mentor，让他帮你review一下代码，并提出可能的问题和建议，让你好好修改。这样的过程，就叫做Code Review。