代码复审结果报告

  在本次代码复审的作业中,我审阅的是我的pair project的partner郝倩的个人项目代码。下面我汇报一下本次代码复审的结果。
  首先我说一下她的代码的优点。首先,她的代码在关键的地方都加上了注释,我在读她的代码的过程中会感觉到轻松很多。同时她的注释基本上没有加在那些显而易见的代码的部分,而是加在必要的点上。第二,从整个程序的结构上看,这份代码的思路十分清晰,并且每一个模块的实现都是使用尽可能简单的方法,这对于日后代码的维护有很好的作用。第三,从细节上来看,这份代码在变量命名上非常好,基本上所有的变量的名字都很明确的展现了这个变量的含义。最后,这份代码对输入和一些敏感的地方坐了必要的检查,提高了代码的稳定性。

     :注释的标注

下面我提一点这份代码不足的地方。首先在测试的时候我发现这份代码的运行效率并不高。第二,在程序中定义了大量的静态变量和静态方法,我认为其中有一些没有必要定义为静态的,这样定义会造成一些不必要的内存浪费。第三,代码在需求改变时做更改会比较麻烦,比如如果我们要求输出排序的前20个单词而不是前十个那么需要进行大量的更改,其实可以通过设置全局变量很简单的实现。但是这里却没有设置。

:过多的静态变量

  最后我想再提一些改进的意见,比如可以在代码中加上一些测试代码以便对代码进行维护。还有我觉得代码的结构可以再调整一下,我认为在主程序中的一些关于输入的判断可以单独构造一个类来进行,是程序的结构更加清晰。最后,如果对语言更熟练一些,有一些代码可以进一步简化,比如在统计文件的部分上。

在代码复审的过程中,我在对方的代码中看到了一些我需要学习的优点,也看到了自己存在的问题,同时也看到了一些自己需要引以为戒的地方。最后,附上我在学习的关于代码评价的内容。

一流代码的特征

  1、稳定可靠(Robustness)

  代码写出来以后,一定要能够运行得非常好,非常稳定可靠。到了产品开发后期,大部分的成本都将投入到产品稳定性的提高。

  2、可维护且简洁(Maintainable and Simple Code)

  在写代码时,首先要考虑的是:写出来的代码不但要自己可以读懂,而且我们的同事、测试工程师都可能要修改这些代码,对其进行增减。所以必要的注释、统一的编程规范等都是非常重要的。

  3、高效(Fast)

  在软件行业中效率是非常重要的,比如搜索引擎。实际上程序的效率提高,有时候很简单,并没有什么神秘之处,如使用数组索引时候,可以用指针方式而不使用数组下标;数组的空间定义应该定义为2的N次幂等等。

  4、简短(Small)

 如果程序写的很罗嗦,随着特性不断增加,程序规模将变大的巨大,Flash空间告急、内存告急、下载升级变的不可忍受,等等,带来的就是成本不断增加,利润不断下降。

  5、共享性(Reusable)

  如果做大型产品开发,程序的共享性也是非常重要的。我“共享”不是指将别人的代码复制到自己的代码中,而是指直接调用别人的代码,拿来即可用。这一方面可以减少代码的冗余性,另一方面可以增强代码的可维护性。如果别人的代码里有Bug,只需修改他的代码,而调用此代码的程序不用进行任何修改就可以达到同步。这同时要求我们在设计的时候,如何考虑系统的内聚和耦合的问题。

  6、可测试性(Testable)

 可测试性在大型软件开发里是很重要的一点。可测试性有时候与可维护性是遥相呼应的,一个具有好的可测试性和可维护性的代码,测试人员可以根据开发提供的维护手册、debug信息手册等就可以判断出程序出错在哪个模块。

  7、可移植性(Portable)

  可移植性是指程序写出来以后,不仅在windows 2000里可以运行,在NT/9X下可以运行,而且在Linux甚至Macintosh等系统下都可以运行。所有这些特性都是一流代码所具备的特性。但是其中有些特性是会有冲突的。比如高效性,程序写的效率很高,就可能变得很复杂,牺牲的就是简洁。好的代码要在这些特性中取得平衡。

时间: 2024-10-17 10:14:46

代码复审结果报告的相关文章

作业三: 代码规范、代码复审、PSP

(1) 是否需要有代码规范         1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反对) 答:首先编码规范 包括了编码风格和其它规范 一个团队遵守一些规范有很多的好处! (1). 遵守编码风格使代码更容易维护 (2). 编码风格使形成代码集体所有制(集体所有制的作用很大,它能有效的增大巴士因子——一个项目能承受多少个程序员被车撞了而不影响项目的正常进行) (3). 编码风格能消除那些长久的纷争(你不需要喜欢这种编码风格.如果你不喜欢里面的某条规

代码规范、代码复审、PSP

作业三: 代码规范.代码复审.PSP 代码规范 代码规范的重要性 一.规范的代码可以促进团队合作  一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码必定会风格迥异.且不说会存在多个人同时开发同一模块的情况,即使是分工十分明晰的,等到要整合代码的时候也有够头疼的了.大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情.统一的风格使得代码可读性大大提高了,人们看到任何一段代码都会觉得异常熟悉.显然的,规范的代码在团队的合作开发中是非常有

结对编程初涉猎——结对伙伴的代码复审

至此为止,个人作业阶段就结束了,从此便进入团队合作阶段.这次是先从结对编程开始,虽然还没有进入正式的开发状态,但也是结对编程的小开端,同时也是一个复习代码复审这部分内容的过程. 阅读目录 1.题目要求 2.结对体验 3.代码审查表 4.队友代码及优缺点评价 5.个人感想 题目要求 要求: (1). 首先在同学中找一个同伴,范围不限,可以在1~5班中随意组合,建议尽量不要找同组的成员,女同学尽量找男同学结对,但是不做强制要求: (2). 从以往个人完成的项目中选择一个作品,例如:以往的数据结构课程

词法分析器代码复审

1.任务要求 ??·对同伴的作品进行代码复审,将对伙伴审查的结果以表格的形式博客中. 2.代码简介 ??·此次博客审查的代码由李云辉同学编写,项目名称为:词法分析器,代码目的是将计算机科学中字符序列转换为单词序列,供语法分析器调用. 3.代码地址 coding.net可运行完整代码地址 4.项目代码 // // main.cpp // cffxq // // Created by LiYuNhUi on 2018/4/8. // Copyright ? 2018年 LiYuNhUi. All r

MVC项目实践(七)——代码复审和运行测试

本次所有的工作都是我们小组分工完成的.同样我们主管代码复审的同学也负责任的在我们完成编码工作之后认真的完成了代码复审的工作. 以下是本次运行截图 选择业务的首页 选择队伍的页面 添加队伍的页面 计分页面 观众详情页面 查询队伍的页面 查询比赛的页面 查询具体比分的页面 以上为主要的页面测试结果.之前设计功能都能够实现.就是美化工作还没做.有些简陋.

代码复审

一.这次复审的是李成帅(130201127)同学的四则运算代码,源代码如下: using System;using System.Collections.Generic;using System.ComponentModel;using System.Data;using System.Drawing;using System.Linq;using System.Text;using System.Threading.Tasks;using System.Windows.Forms; names

软件工程第二周作业:代码规范和代码复审

0x01 :代码规划的要求 Q:这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反驳) 首先,我们需要明确编码规范的定义,编码规范同时包括了编码风格和其它规范(代码设计上的规范,如设计模式.程序设计.模块之间的逻辑关联等). 编码风格,牵扯到“缩进.空格使用.注释.命名习惯”等多方面的因素,是依致特定编程语言制定的软件工程开发的“约定”,而相同的编码风格,可以使得软件开发过程中轻松浏览任意一段代码,充分保证不同的开发人员能够依据统一的编码格式轻松理解代码的逻

个人博客作业-Week2 (代码规范, 代码复审)

代码规范: 1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西. 编码规范它包含了代码格式,还包括了编码风格和其他规范,通常涉及:缩进.空格使用.Tab使用 注释.命题习惯.代码行长度和语言特点风格,从而使大家能够很方便得互相阅读对方的代码从而促进 团队中的沟通与交流.不是浪费时间. 2.我是个艺术家,手艺人,我有自己的规范和原则. 艺术家的表现层次如果只是在规范上面,显然不是个优秀的艺术家,通过大家都容易接受的方式可以 让自己的创造力更好得表现出来. 3.规

作业三: 代码规范,代码复审

是否需要有代码规范 1.反驳.代码规范是有实际纪意义的,斌不是形式主义的浪费时间. 2.反驳.编码风格不是代码规范. 3.反驳.代码规范就是要求格式一样的,不应该有例外. 4.反驳.一个人的规范不是规范.一个团队内部的规范也不是代码规范,所有人都遵守的才是代码规范, 总结:代码规范对团队合作很重要.一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码度是不同风格的,即使是分工十分明晰的,等到要整合代码的时候就会很麻烦.别人看你的代码需要很长时间,这样很没有效率.这样去读别人