软件工程第四次作业——代码规范

作业要求：https://edu.cnblogs.com/campus/nenu/SWE2017FALL/homework/993

结对伙伴：田继平

一、代码规范原因：

       代码是程序员的面子，《构建之法》第59页写到“软件都是在相互合作中完成的，合作的最小单位是两个人，两个工程师在一起，做的最多的事情就是‘看代码’。每个人都能看别人你的代码，并发表意见。”，第60页写到“计算机只关心编译生成的机器码，你的程序采用哪种缩进风格，变量名有无统一的规范等，与机器码的执行无关”，所以，代码格式最终还是人在看。由此可见，编写出整洁优雅的代码显得尤为重要。

二、代码规范：

     要求1：《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格，希望切实可行，容易观察和客观检验。　　

　　（一）、 代码风格规范

　　　　1、     缩进

　　　　　　4个空格。

　　　　　　在Visual Studio 和其他的一些编辑工具中都可以定义Tab键扩展成几个空格键。不用Tab键的原因：Tab键在不同的情况下会显示不同的长度，严重干扰阅　　　　　　读体验。

　　　　2、     空格

　　　　　　A、函数名之后不留空格，紧跟左括号“(”。

　　　　　　B、一元操作符（如“ !”、“ ++”、“ --”）等前后不加空格。

　　　　　　C、使用if{} else，不要一直用if去判断

　　　　3、     断行

　　　　　　不把多条语句放在一行上。eg: a = 1;

　　　　　　　　　　　　　　　　　　　　b = 2;

　　　　4、     括号

　　　　　　A 、对齐。

　　　　　　在复杂的条件表达式中，用括号清楚的表示逻辑优先级。

　　　　　　B、 大括号匹配纵行对齐。

　　　　5、     大小写

　　　　　　变量、参数：全小写。eg: int name;

　　　　6、     注释

　　　　　　本次作业代码注释采用“ //…”。

　　　　　　注释位置：与被描述的代码相邻，上方或右方，不放下方。

　　　　　　边写代码或改代码边注释，可保证注释与代码的一致。不留多余无用的注释。

　　（二）、代码设计规范

　　　　1、if 后面必须加else。

　　　　2、一个函数实现一个功能。

　　要求2 ：记录完成本周作业过程中，《代码风格规范》执行情况。

　　　　1、缩进

　　　　　　纠正次数  14次

　　　　2、函数名之后不留空格，紧跟左括号”(“

　　　　　　纠正次数 4次

　　　　3、像 if、 for、等关键字之后有空格，再跟左括号“(“

　　　　　　纠正次数 2次

　　　　4  、使用if{} else，不要一直用if去判断

　　　　　　纠正次数 2次

　　　　5 、不把多条语句放在一行上

　　　　　　纠正次数 2次

　　　　6、 在复杂的条件表达式中，用括号清楚的表示逻辑优先级。

 　　　　　　纠正次数 3次

　　　　7、大括号匹配纵行对齐

       　　　　纠正次数 5次

　　　　8、变量、参数：全小写。eg: int name

      　　　　纠正次数 6次

　　　　9、 注释位置：与被描述的代码相邻，上方或右方，不放下方。

      　　　　纠正次数 4次

　　　　10、边写代码或改代码边注释，可保证注释与代码的一致。不留多余无用的注释。

　　　　　　纠正次数 6次