张宵 20200924-4 代码规范,结对要求

本次作业要求参见:https://edu.cnblogs.com/campus/nenu/2020Fall/homework/11244

结对队友:韩亚光,感谢韩同学在本次作业中的帮助

 

要求《代码规范》包括10项条款。(10分)

1.列宽

  代码列宽控制在110字符左右。

2.缩进(废除)

  四个空格长度。在Visual Studio中设置tab键为四个空格键长度。

3.括号()

  • 复杂条件表达式,需要用括号表明优先级
  • 左括号“(”不要紧靠关键字,中间用一个空格隔开。
  • 左括号“(”与方法名之间不要添加任何空格。

4.花括号 {}

  • 每个“{”和“}”均单独占一行,不与任何语句并行。
  • If、while、do语句后一定要使用{},即使{}只有一条语句
  • 右花括号“}”后需加一个注释,便于找到与之对应的“{”

5.空格

  • 关键字和左括符 “(” 应该用空格隔开。如while (true)
  • 多个参数用逗号隔开,每个逗号后都应加一个空格。
  • 除了 . 之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。
  • 语句中的表达式之间用空格隔开,如for (expr1; expr2; expr3)

6.换行

  • 一行定义一个变量
  • 当表达式超出或即将超出规定的列宽,遵循以下规则进行换行

          1、在逗号后换行;

          2、在操作符前换行;

          3、规则1优先于规则2。

7.空行

  • 不能包含多个空行
  • 以下情况使用一个空行:

    1、 函数和函数之间

    2、 函数中不同的逻辑块中

    3、 注释与它注释的语句间不空行,但与其他的语句空一行

8.命名

  • 所有类型、类、函数名采用小写命名方式。如果变量名含有多个实词,中间用短下划线_连接;
  • 所有的变量名采用Camel命名方式

9.注释

  • 多行注释:指定函数、类的功能
  • 单行注释:指定函数内的代码注释。如变量声明、代码段解释,单行语句,注释在语句后;代码段注释在代码段前

10.声明

  • 一行只作一个变量声明
  • 所有函数声明放在头文件中

11.常量(补充)

  • 常量名全大写,中间用下划线“_”连接

 

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

序号 代码规范 违反及纠正次数 条款变更
1 列宽 韩亚光1次,已提醒改正 减弱
2 缩进 违反次数0 废除
3 括号 张宵4次,已提醒改正 规则有效,不变更
4 花括号 韩亚光3次,已提醒改正 规则有效,不变更
5 空格 张宵8次,已提醒改正 增强
6 换行

韩亚光2次,已提醒改正

张宵1次,已提醒改正

规则有效,不变更
7 空行

韩亚光2次,已提醒改正

张宵1次,已提醒改正

增强
8 命名

张宵2次,已提醒改正

韩亚光1次,已提醒改正

规则有效,不变更
9 注释 韩亚光1次,已提醒改正 规则有效,不变更
10 声明 张宵1次,已提醒改正 规则有效,不变更
11 常量 张宵3次,已提醒改正 增强
posted @ 2020-09-27 15:46  张宵  阅读(106)  评论(0编辑  收藏