个人作业-Week3:代码复审

软件工程师的成长

  我在上大学之前,对于软件工程师之类并无概念,并且高初中的电脑课也从未提及过写代码之类的东西,更多的都是一些教一些办公软件的使用(笑,明明电脑课总是因为老师“有事”变成其他课,根本就没上过几节吧),来到大学后得知一些同学高中就开始搞各种竞赛后,我感到十分惊讶,什么,从小热爱学习XX,一路坚持,最终成为XX大师的人小说以外真的有啊。大学之后的课余时间更是鲜有与软件工程相挂钩的事情,用一句话概括,就是过着这些博主批判对象的生活,十分尴尬。选这个课就是觉得应该做出些改变了,然而在第一次作业就尴尬了,说实话第一次作业我先前还真写过,没错,就是地铁规划,一模一样的题目,于是想当然得觉得很简单,没有好好构思就直接动手,然后就出现了BUG调了很长时间。。然而具体的改变应该做些什么,还是不甚确定,希望能够在这学期中找明自己的道路。

General

  • Does the code work? Does it perform its intended function, the logic is correct etc.答:存在一些问题,如

  • Is all the code easily understood?

  Yes

  • Does it conform to your agreed coding conventions? These will usually cover location of braces, variable and function names, line length, indentations, formatting, and comments.

  Yes

  • Is there any redundant or duplicate code?

  No.

  • Is the code as modular as possible?

  No.

  • Can any global variables be replaced?

  No.

  • Is there any commented out code?

  No.

  • Do loops have a set length and correct termination conditions?

  No.

  • Can any of the code be replaced with library functions?

  No.

  • Can any logging or debugging code be removed?

  No.

Security

  • Are all data inputs checked (for the correct type, length, format, and range) and encoded?

  Yes.

  • Where third-party utilities are used, are returning errors being caught?

  No.

  • Are output values checked and encoded?

  Yes.

  • Are invalid parameter values handled?

  Yes.

Documentation

  • Do comments exist and describe the intent of the code?

  No.

  • Are all functions commented?

  No.

  • Is any unusual behavior or edge-case handling described?

  No.

  • Is the use and function of third-party libraries documented?

  No.

  • Are data structures and units of measurement explained?

  No.

  • Is there any incomplete code? If so, should it be removed or flagged with a suitable marker like ‘TODO’?

  No.

Testing

  • Is the code testable? i.e. don’t add too many or hide dependencies, unable to initialize objects, test frameworks can use methods etc.

  Yes.

  • Do tests exist and are they comprehensive? i.e. has at least your agreed on code coverage.

  No.

  • Do unit tests actually test that the code is performing the intended functionality?

  No.

  • Are arrays checked for ‘out-of-bound’ errors?

  No.

  • Could any test code be replaced with the use of an existing API?

  No.

时间: 2024-12-04 10:15:08

个人作业-Week3:代码复审的相关文章

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

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

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

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

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

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

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

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

个人博客作业2--代码规范和代码复审

代码规范: 代码规范作为coders所遵守的一个默认的准则,其存在的意义是十分重要的. 不以规矩,不能成方圆.如何正确.规范的工作,如何为我们的工作提供依据,并能够高效率的执行,这些都需要正确.行之有效的规范.而代码规范正是保证这一切的基础.它使得不同的人在相互合作的时候能够更加迅速.容易地理解彼此的工作进度与代码信息,为之后的协作提供一个良好的沟通环境.一个人的能力十分有限,所以与他人的沟通协作不可或缺,这更加彰显出代码规范的重要. 1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们

20180320作业2:进行代码复审训练

代码复审检查表 1.概要部分 (1)代码符合需求和规格说明么? 基本符合 (2)代码设计是否考虑周全? 不是特别周全 (3)代码可读性如何? 有部分标注 (4)有冗余的或重复的代码吗? 比较简洁  (5)代码的每一行都执行并检查过了吗?  没有 2.设计规范部分 (1)设计是否遵从已知的设计模式或项目中常用的模式?  是 (2)有没有硬编码或字符串存在?  无 (3)代码有没有依赖于某一平台? 无  (4)有没有无用的代码可以清除?  无 3.代码规范部分    比较规范 4.具体代码部分 (1

代码复审

一.这次复审的是李成帅(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

代码规范、代码复审、PSP

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

结对代码复审结果

Q:是否需要有代码规范 需要,我认为非常需要,虽然现代曾经也举办过乱码大赛.但是,代码作为一种车鞥徐语言的同事也是程序员之间的交流的媒介,可读性强可移植性强是非常重要的.就我个人而言,我觉得,我更喜欢每行代码之间都有空行,大括号之后要有换行,程序要换行和缩进非常明显和统一,这样看着才会增加可读性,便于理解. 这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西? 并不是啊...如果你这样的话,等你走上工作岗位上看到一个程序要上万行的代码的时候,我们都是知道的,每一个

代码复审结果报告

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