双人项目之代码规范准则

该课程的双人项目是与王狄航同学合作的，通过对软件工程导论这门课程的学习，让我更清楚的认识到代码规范的重要性。

  什么叫规范？在C语言中不遵守编译器的规定，编译器在编译时就会报错，这个规定叫作规则。但是有一种规定，它是一种人为的、约定成俗的，即使不按照那种规定也不会出错，这种规定就叫作规范。
    虽然我们不按照规范也不会出错，但是那样代码写得就会很乱。大家刚开始学习C语言的时候，第一步不是说要把程序写正确，而是要写规范。因为如果你养成一种非常不好的写代码的习惯，代码就会写得乱七八糟，等到将来工作面试的时候，这样的习惯可能会让你失去机会。

代码规范化的好处

代码规范化的第一个好处就是看着很整齐、很舒服。假如你现在用不规范的方式写了一万行代码，现在能看得懂，但等过了三个月你再回头看时就很吃力了，更不要说给别人看了。所以代码要写规范，比如加注释就是代码规范化的一个思想。在一般情况下，根据软件工程的思想，我们的注释要占整个文档的20%以上。所以注释要写得很详细，而且格式要写得很规范。

一、规范的代码可以促进团队合作
二、规范的代码可以减少bug处理
三、规范的代码可以降低维护成本
四、规范的代码有助于代码审查
五、养成代码规范的习惯，有助于程序员自身的成长

代码风格规范

   结合《java开发手册》v1.5.0华山版和华为编码规范（c语言版）的学习和了解，我对双人项目的代码编写制定了一份简化版代码风格规范：

代码规范化基本上有七大原则，体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

1) 空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，但是值得。
    规则一：定义变量后要空行。尽可能在定义变量的同时初始化该变量，即遵循就近原则。如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。
    规则二：每个函数定义结束之后都要加空行。
    总规则：两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。

2) 空格

 规则一：关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。
    规则二：函数名之后不要留空格，应紧跟左括号(，以与关键字区别。
    规则三：(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。
    规则四：,之后要留空格。如果;不是一行的结束符号，其后要留空格。
    规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的前后应当加空格。
    规则六：单目运算符 !、~、++、－－、－、*、& 等前后不加空格。
    规则七：像数组符号[]、结构体成员运算符.、指向结构体成员运算符->，这类操作符前后不加空格。

3) 成对书写

成对的符号一定要成对书写，如 ()、{}。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。

4) 缩进

缩进是通过键盘上的 Tab 键实现的，缩进可以使程序更有层次感。原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。

5) 对齐

对齐主要是针对大括号{}说的：
规则一：{和}分别都要独占一行。互为一对的{和}要位于同一列，并且与引用它们的语句左对齐。
规则二：{}之内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不同的继续缩进。

6) 代码行

规则一：一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。
规则二：if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。

7) 注释

C语言中一行注释一般采用//…，多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下，源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码，但注意不可过多地使用注释。
    规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。
    规则二：如果代码本来就是清楚的，则不必加注释。

规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。

8）行宽

单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则： 

1. 第二行相对第一行缩进4 个空格，从第三行开始，不再继续缩进，参考示例。
2. 运算符与下文一起换行。 
3. 方法调用的点符号与下文一起换行。
4. 方法调用中的多个参数需要换行时，在逗号后进行。
5. 在括号前不要换行。