第四次软工作业-代码规范

代码规范

结对编程成员:
刘耀泽:http://www.cnblogs.com/liuyaoze/
杨梓瑞:http://www.cnblogs.com/vector121/
git 地址:https://git.coding.net/Vector121/f4.git

要求1: 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。比如, 每个函数不超过5行,对于初学是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。

在和杨梓瑞同学进行讨论后,我们从三个大方面定义出如下规范:
格式:

1. 每个函数的行数不能大于50行。
2. 函数间使用至少使用两次换行以便于读者区分。
3. 使用大括号时需在单独一行,且大括号上下对齐。
4. 函数中的参数和逗号间使用空格隔开。
5. 单行代码很长,不能一次性映入眼帘,则另起一行,规范排版。
6. 运算符和操作数间使用一个空格分开。
7. 变量的声明尽量集中在一起。与功能语句用空行分开。

命名:

8. 变量和函数的命名使用具有其功能含义的英文单词或词组简写。
9. 定义组合函数名时,第一个单词为动词且首字母大写。
10. 定义的变量名不宜过长,适当缩写,但可以被识别出原单词含义。

注释:

11.注释统一加在语句或函数名上方。
12.除主函数外,每个函数名上方都加固定格式可表述功能的注释。

要求2: 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。

posted @ 2017-10-11 15:37  刘耀泽  阅读(196)  评论(1编辑  收藏  举报