作业20180925-5 代码规范,结对要求
此作业的要求参见:
https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147
结对伙伴:张俊余
代码规范针对项目:四则运算作业
要求1 《代码规范》包括10项条款。(10分)
一、命名
1.变量、函数和类等的命名中不能出现 $ 和下划线 _ ;
2.类名统一使用UpperCamelCase 风格,必须遵从驼峰形式。方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式;
3.命名变量时要分行命名;
二、代码格式
4.大括号的使用约定:左大括号前换行,左大括号之后换行,右大括号前换行,右大括号如果有else 等则不换行,否则换行;
5.任何二目、三目运算符的左右两边都需要加一个空格;
6.方法参数在定义和传入时,多个参数逗号后边必须加空格;
7.采用4个空格缩进,严禁使用tab缩进;
8.在 if/else/for/while/do 等保留字与括号之间都必须加空格,执行语句必须使用大括号,即使只有一行也必须使用大括号;
三、注释及注释格式
9.类、方法名、参数名、成员变量、局部变量、全局变量等在声明时行后必须带注释;
10.注释的双斜线与注释内容之间有且仅有一个空格;
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。
代码规范ID |
违反次数 |
违反举例 |
纠正次数 |
对此项规范的操作 |
1 |
1 |
定义true_Num时错误使用了下划线(及时纠正后未再犯错) |
1 |
保持 |
2 |
8 |
定义测试方法时未使用lowerCamelCase 风格, 而使用了UpperCamelCase 风格,eg. TestCreatRPN() |
8 |
保持 |
3 |
3 |
public decimal operateNumOne,operateNumTwo, operateNumThree, operateNumFour; |
3 |
保持 |
4 |
6 |
均为右大括号后直接换行 |
6 |
此项规范时长违反,但最终决定依旧保持 |
5 |
7 |
operators[0] + nums[1](加号后为两个空格); string[] nums =getRandomNum();(等号后未加空格) |
7 |
保持 |
6 |
2 |
int flag = rm.Next(1,10);逗号后未加空格; |
2 |
保持 |
7 |
3 |
使用了tab未使用四个空格 |
3 |
保持 |
8 |
18 |
保留字与括号未空格;执行语句严格使用大括号 |
12 |
改了12次后决定部分废弃,修改为“在 if/else/for/while/do 中,执行语句必须使用大括号,即使只有一行也必须使用大括号;” |
9 |
7 |
成员变量、局部变量、全局变量未给出注释 |
3 |
部分废弃,修改为“类、方法名在声明时,行后必须带注释” |
10 |
9 |
public static void JudgeOperator(Stack<string> opStack, Stack<string> numStack, string x)//判断运算符 (//后未空格直接写注释内容) |
9 |
保持 |
注:表格展示不全时可查看下图