zoukankan      html  css  js  c++  java
  • 计算与软件工程作业四(一)

    问题 回答
    作业要求 第四周作业
    课程目标 代码复审
    在哪方面帮我实现课程目标 能够帮助我更好的规范代码风格;
    参考文献 (https://www.cnblogs.com/xinz/archive/2011/11/20/2255971.html)

    作业1

    每个人针对之前两次作业所写的代码,针对要求,并按照代码规范(风格规范、设计规范)要求评判其他学生的程序,同时进行代码复审(按照代码复审核表)

    代码复审核查表

    1.概要部分
    (1)代码能符合需求和规格说明么?
    (2)代码设计是否有周全的考虑?
    (3)代码可读性如何?
    (4)代码容易维护么?
    (5)代码的每一行都执行并检查过了吗?
    2.设计规范部分
    (1)设计是否遵从已知的设计模式或项目中常用的模式?
    (2)有没有硬编码或字符串/数字等存在?
    (3)代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)?
    (4)开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?
    (5)有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)
    3.代码规范部分
    (1)修改的部分符合代码标准和风格么(详细条文略)?
    4.具体代码部分
    (1)有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?
    (2)参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?
    (3)边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?
    (4)有没有使用断言(Assert)来保证我们认为不变的条件真的满足?
    (5)对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?
    (6)数据结构中是否有无用的元素?
    5.效能
    (1)代码的效能(Performance)如何?最坏的情况是怎样的?
    (2)代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中 string 的操作是否能用StringBuilder 来优化)?
    (3)对于系统和网络调用是否会超时?如何处理?
    6.可读性
    代码可读性如何?有没有足够的注释?
    7.可测试性
    代码是否需要更新或创建新的单元测试?
    还可以有针对特定领域开发(如数据库、网页、多线程等)的核查表。

    代码复审截图








    总体看法

    代码规范分为代码风格规范和代码设计规范,二者都非常重要,一个优秀的代码应该符合简明,易读,无二义性的原则,帮助读者更好的理解代码,在这次的作业中,我先进行了同伴复审,发现别人代码的优秀与不足之处,同时与自己的代码进行比较,进行自我复审。
    通过这次学习,我意识到代码复审的重要性,它可以找出代码的错误,包括逻辑错误,算法错误,潜在的错误和回归性错误,同时可以发现可能改进的地方,也可以帮助我们熟悉每个问题的解决方法和相关知识。

  • 相关阅读:
    simple-LDAP-auth
    User Attributes
    webpack 模块标识符(Module Identifiers)
    详解webpack中的hash、chunkhash、contenthash区别
    [转] 插件兼容CommonJS, AMD, CMD 和 原生 JS
    Exif.js 读取图像的元数据
    [转] 跨域
    [转] 理解Web路由
    [转] React 是什么
    [转] Web MVC简介
  • 原文地址:https://www.cnblogs.com/yzzzw/p/12636544.html
Copyright © 2011-2022 走看看