这次作业,由我和李圆圆同学共同完成,结合老师的要求和对资料的查阅,对程序实施有效的约束,让其方便观察。
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
排版部分:
- 大括号匹配纵列对齐。大括号的对齐使整个程序看起来整洁,把程序分成若干块,进行翻阅时易于查找。
- 一行最多写一行语句。清楚易懂,不会造成语句的混乱及误删等问题造成不必要的时间浪费。
- if,while,do while,for,case等语句独占一行。
- 每个函数有效代码长度不要超过 60 行。
- 循环判断语句 要用花括号括起(即使只有一个语句),遵循块的通用规则。
- 注释使用//注释符,注释放在语句上方或右方。
- 参数之间的逗号后要加一空格。如:method1(int a, int b)
- 使用空行分割代码块。
- 代码左对齐,函数,类,结构体都采用缩进方式。
- include语句放在程序头部。
命名部分:
- 函数名命名通俗易懂,让人一看就能明白该函数所实现的功能。例如:bool isPra(char c)该函数为判断是否为括号。
- 使用多个单词组合进行命名时,第一个单词的首字母小写,其它单词的首字母大写。
其他规范:
- 程序在必要的地方必须要有注释,注释要简洁明了。
- 进行代码维护时,要实时更新注释,避免误解。
- 严禁使用未初始化的变量。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。
记录一:大括号匹配纵列对齐非常重要,因为在编写程序的过程中,一不小心就可能丢失括号,这样的情况不断发生,所以在编写过程中,边写边对齐。
记录二:尽量避免使用do while语句,因为其条件在底部,读者要浏览整个循环体才能明白循环范围。
记录三:一行只写一条语句。在编程过程中,遇到非常短的语句都整合成一行中,以减少代码的行数,但实际上,代码不仅不美观,还容易造成小错误。
记录四:在对程序的后期修改中,有些注释没有及时修改,造成逻辑混乱。