代码书写规范的重要性

代码的书写规范是非常重要滴，然而代码书写规范的重要性往往被大多数粗心的童鞋忽略，这里小七先简单的阐述一下代码书写规范的重要性。

目前来说，由于受到知识掌握的限制，刚刚接触 C/C++的可爱们通常只能通过一些简单而且代码量很小的程序进行练习。由于代码较短，涉及到的变量及函数并不多，此时往往显示不出来代码规范书写的重要性。

但是，随着所学知识的深入，编写的程序可能会有数百行甚至上千行，涉及到的变量和函数会多达数十个。如果此时仍然不注重代码的书写规范，那么写出的代码可读性很差，不利于错误的查找，也同样不利于团队开发的项目。如果不良的代码书写风格不尽早纠正的话，会对程序猿今后的工作造成极大的负面影响。小七先献上一段不堪回首的过去（A+B=C）：

上面的程序不过才短短的几行而已，却让人感到格式不清晰，阅读十分困难。小七都难以想象如果按照这样的书写格式写出的几十行甚至成败上千行的程序会是什么样。可以肯定的是这样的程序小七是不会再写下去的！！接下来奉上相对规范的 C/C++代码书写方式：

这段相对规范的代码读起来感觉就比较清晰，一段良好书写格式的代码给人的感觉是舒畅的，这样的代码便于阅读，如果程序发生错误时查找错误也相对容易些。大家还记得老师上课强调的锯齿状的代码不？小可爱们要充分的认识到代码书写规范的重要性，并及早开始规范自身的代码书写哦。

不幸的是国内很多高校和课本忽视了良好的代码书写规范的重要性，导致了很多学生在书写代码时格式混乱，代码难以阅读，这在我们优秀的中北校园当然是不会存在的啦~七院的老师们都棒棒哒！！

下面就是可爱的七七给大家罗列的常见问题啦~（划重点划重点）

1.空行问题

规则 1：在每个类（C++）、结构体声明和函数定义结束后要加一个空行。

规则 2：在函数体内，逻辑关系紧密的语句之间不加空行，但是其他没有紧密逻辑关系的地方要加空行。

良好的空行使用方式（样例）：

童鞋们要注意空行的使用方式，合理空行使用会增强代码的可读性，因此小七强烈建议从学习 C/C++之初就要对代码行中的空行问题。在平时写代码的时候就要对这点加以注意。这样才能养成良好的代码书写习惯。

2.代码行问题

规则 1：每一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。

规则 2： if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}，这样可以防止书写失误。

当然，每行仅仅定义一个变量可能对于很多人都会非常的不习惯。比如说为了定义一个整型变量‘i’就单独消耗一行，因此一行只定义一个变量可以慢慢的适应或是暂且当做一条建议。但是对于任意的一行代码，不要同时写下多条语句，这样在大工程中会显得代码一场混乱。因此一定要做到一行代码只书写一条语句。

对于第二条规则来说，其实小七也不大习惯这样做。例如 if 语句 后面只有一条 break 语句时很自然的就直接将 break 语句接到 if 的后面去了。尽管看起来 规则 2 的规定有些不必要，但是经过仔细思考后觉得这样做确实是有道理的。如果从学习编程的开始就注意这些书写问题，看到文档中说明的规则就不会肝胆不习惯了。

3.代码行内的空格问题

规则 1：关键字之后一定要留空格。const、virtual（C++中的关键字）、inline、 case等关键字之后至少要留一个空格,否则无法辨析关键字。而 if、for、while 等关键字之后应留一个空格再输入左括号以突出关键字。

规则 2：函数名之后不要留空格，紧跟左括号以与关键字区别。

规则 3：左括号向后紧跟, 右括号 、逗号 、分号向前紧跟,紧跟处不留空格。

规则 4：逗号之后要留空格,如 Function(x, y, z)。如果分号不是一行的结束符号, 其后要留空格,如 for (initialization; condition; update)。

规则 5：二元运算符的前后要加空格，但是一元运算符的前后不加空格。

规则 6：下标运算符、成员运算符前后不加空格。

规则 7：对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格,如： for (i=0; i<10; i++)和  if ((a<=b) && (c<=d))  

下面的一段求解 n 个数中大值的代码的书写基本符合上述几个规则的要求，希望同学们参考一下：

4.大括号的对齐问题

规则 1：程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语 句左对齐。

规则 2：{ }之内的代码块在‘{’右边对齐，通常都是空四个对齐。

良好的大括号对齐方式：

在积累了一定的代码书写经验后，会发现其实大括号的对齐对代码的书写风格影响是非常大的。如果没有养成良好的大括号对齐习惯，那么书写的代码往往看上去一团糟，不便于错误的检查。所以说大括号的对齐是代码书写过程中非常重要的一点，从现在开始书写代码就要注意这点，这样以后才能写出书写风格较好的代码。

5.长行拆分的问题

有时在代码书写的过程中可能会出现某一行代码很长的现象，为了方便程序审阅我们需要将长行进行拆分。当然，对于长行来说并不是随便拆分的，拆分长行往往需要遵从一定的规则，否则会适得其反。

多数程序猿认可的一点是：

在长行拆分时，从优先级较低的操作符处对长行进行拆分，长行拆分后应该将拆分处的操作符置于新拆分出来的行的前端（分号除外）。新拆分出的行要向前缩进，让代码保持整齐。

6.代码注释的问题

代码书写过程中注释是非常必要的，尤其是在一些代码量很大的程序中。适当的注释可以帮助程序员更快更好的阅读代码，不过注释也不能乱写。

首先代码注释应该是对程序中的代码行起到一个提示作用，而不是写一个技术文档。因此在程序中写注释时应该在关键地方，这样就可以起到对代码的提示作用。当然了，如果代码本身的意义已经很明确就不要加注释了，这样显得有些多余。

另外我们要注意注释与代码的一致性，如果修改了被注释的代码，那么相应的代码注释就应该及时进行修改，这样可以防止一些不应该出现的问题发生。

注释应该表达准确，不应该具有二义性。

对于注释的放置也是有一定的要求，注释可以置于需要注释的代码的上一行或者右边，但是不应该放置于待注释代码的下一行，这点应该要记住。

函数及变量的命名规则

实际上函数及变量的命名是非常重要的一点。对于一个程序来说对函数和变量的命名都应该改使用与其功能相关的英文单词来命名，不要简单地用 fun 给一个函数命名。这样对于一个程序来说更加让人易于理解，程序的可读性大大提高。

因此现在我们就应该把函数及变量的命名规则重视起来，好的编程习惯要从学习编程之初就开始养成。

注释题目

在平时最好养成一种习惯：

在题目代码之前加注释：

尽管考试或者比赛中我们没有过多的时间去写这个，但是在平时做题时小七建议大家这样做。因为如果明确的分析出题目的思路和需要注意的地方后再敲代码，可以很大程度的提升做题的准确率，也会避免一些敲代码时可能出现的问题。

小结：

代码书写风格问题大多是因为在正常高校的 C/C++教育中没有被重视而导致的，但是这绝对不是我们代码书写风格混乱的一个借口，现在开始规范代码的书写完全来得及，起码比在工作时发现自己的代码都没法看下去时要好。

同学们应该从现在开始规范自己的代码书写，对于以前写过的题目也要将代码进行规范，趁现在不良的代码书写习惯还没有养成尽快的规范代码书写习惯，良好的代码书写习惯会让我们从中获益的。

另外在做题的时候希望同学们能在题目代码前加上注释，注释内容是这道题的解题的思路和题目的考点（这个注释应该在敲代码之前打好， 写完题目再写这个效果显然就没有那么好了）。

以上就是小七在大可爱们那里取到的真经liao

希望可以帮到大家哦！！！

官方认证空间：
 邮箱：
官方新浪微博@中北大学大数据学院
主编：阮臻
责编：姜鑫源
本期编辑：实习编辑 魏孟梁 韩康泽