4-1 代码规范

Posted 2020-10-10

结对同学：方铭

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

《代码规范》是我和伙伴方铭同学在阅读《构建之法》后并结合实际制定的。最终确定代码规范如下：

A.代码量：            I.代码总行数不超过500行

                             II.单个函数总行数不得超过60行。

B.代码缩进：        III.《构建之法》书中有提到过Tab在不同情况下会显示不同的长度，统一规定代码缩进采用4个空格。

C.括号匹配：        IV.“{”“}“同一级别匹配应明确就表示出代码优先级，尤其是在多层嵌套循环函数中。

D.代码空行:           V.不同函数之间空一行。

                             VI.在函数内部，函数内部变量声明与函数代码之间空一行。

E.代码空格：        VII.函数参数列表中不同参数之间用一个空格分开。

F.变量命名：        VIII.在变量声明时应有实际意义不可凭空想象，尽量遵循“匈牙利命名法”。

G.代码注释：        IX.阐明函数功能的注释应放在该段函数代码前。

                             X.某一行标注的注释为防止看错行应紧随该行代码右侧标注。

H代码路径：         XI.为防止代码运行在调试加载过程中出现未知错误，规定代码运行路径在全英文路径下，并且为防止乱码，控制台提示采用英文（本次作业要求是给小学数学老师使用，此处假设小学数学老师英语水平为CET4）。

要求2《代码风格规范》执行情况记录。包括记录每一条规则的违反和纠正、次数，规范中某项条款的增强、消弱、或废除。 

A.代码量：总代码量是根据上网查阅资料确定的，并在最终完成代码后没有超出预期代码量，最后完成的代码总行数为349行，最长的单个函数代码为34行。

B.代码缩进：C.括号匹配:

在代码执行过程中由于代码多层嵌套，编写代码时逻辑不够清晰，导致代码缩进出现不规范，如下图所示：

    后期执行代码规范检查代码，修改后如图所示：

D.代码空行:

   在编写代码时为了方便好记并未对代码进行空行等严格的代码规范书写，函数之间基本都没有空行，截取部分如下图所示：

   后期执行代码规范检查代码，修改后如图所示：

E.代码空格:大部分函数声明变量时都能够遵循该规范，只有个别违背该规范，也可算作本能反应（所以在后面补了一条必要的代码规范）如下图所示：

   后期执行代码规范检查代码，修改后如图所示：

F.变量命名：

  虽有注释但是命名不够准确容易给人造成误解歧义：

   后期执行代码规范检查代码，修改后命名如图所示：

H.代码路径.:代码路径规范是在后期运行调试代码添加的一条规范，原本控制台采用中文提示，但是在visual studio2017中却显示乱码，经过各种方法调试却无法消除乱码，所以添加此项规范要求。

 控制台乱码图如下图所示：

 

控制台提示部分转换成英文如下图所示：