个人作业-week2

一、代码复审CheckList

1.概要部分

  • 代码能符合需求和规格说明么?
    • 符合。
  • 代码设计是否有周全的考虑?
    • 能够正确生成和求解数独。
  • 代码可读性如何?
    • 可读性一般,声明函数的时候都有注释说明功能,但单个函数有的较长。
  • 代码容易维护么?
    • 可能比较难,对于需求的改动可能会牵扯到比较多的函数的改动。
  • 代码的每一行都执行并检查过了吗?
    • 是的。

2.设计规范部分

  • 设计是否遵从一致的设计模式或项目中常用的模式?
    • 没用设计模式。
  • 有没有硬编码或字符串/数字的存在?
    • 有的,许多地方都有数字出现,如9,200,70等。
  • 代码有没有以来某一平台,是否会影响将来的移植?
    • 生成的exe文件,应该比较多的平台都能用。
  • 开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?
    • 没有。
  • 有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)
    • 没有。

3.代码规范部分

  • 修改的部分符合代码标准和风格么(详细条文略)? 
    • 修改的部分代码标准风格一致。

4.具体代码部分

  • 有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?
    • 对错误信息做了处理(inputcheck),并检查了返回值。
  • 参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?
    • 没有错误,字符串长度是字节的长度,从0开始。
  • 边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?
    • 用if、else处理,但有的地方没有else而是直接返回,没有死循环。
  • 有没有使用断言(Assert)来保证我们认为不变的条件真的满足?
    • 没用。
  • 对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?
    • 有申请全局变量char的数组,在程序运行完后释放掉;没有资源泄露,文件都有关闭。
  • 数据结构中是否有无用的元素?
    • 没有。

5.效能

  • 代码的效能如何?最坏的情况是怎样的?
    • -c 1000000用了9.75秒;-s 有点慢。
  • 代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中string的操作是否能用StringBuilder 来优化)?
    • 把手动输入数独种子和取4个数互换可以写成代码自动生成。
  • 对于系统和网络调用是否会超时?如何处理? 
    • 没有调用。

6.可读性

  • 代码可读性如何?有没有足够的注释? 

7.可测试性

  • 代码是否需要更新或创建新的单元测试? 
    • 需要创建单元测试
  • 还可以有针对特定领域开发(如数据库、网页、多线程等)的核查表。 
    • 没有。

附上Github comment

二、设计一个代码规范

请根据你个人项目使用的语言,尝试使用其中的一款工具,回答以下问题:

  • 工具提供的代码规范和你个人的代码风格有什么不同?
    • tab为4个空格。
    • =等符号左右都有空格。
    • for()中分号后面有一个空格。
    • 我用的c#,感觉差不多。
  • 工具提供的代码规范里有哪些部分是你之前没有想到的?

    • tab为4个空格
  • 为什么要这样规范?这样规范有意义吗?
    • 提高代码的可维护和可读性,便于修改。
    • 美观
    • 有助于团队统一风格后审查代码。

结对编程时使用的代码规范

  • 缩进:4个空格
  • 行宽:100字符
  • 在复杂的条件表达式中,用括号清楚地表示逻辑优先级。
  • 断行都用{}并单例一行
  • 可以将多个相同的类型的变量定义在一行。
  • 命名:匈牙利命名法。
  • 函数名第一个字母大写,变量都小写,宏定义都大写。
  • 注释只用ASCII字符,不用中文或特殊字符,函数有写在上一行的注释说明。
  • 不用goto
posted @ 2017-10-03 22:22  qwellk  阅读(153)  评论(0编辑  收藏  举报