代码复审实战

代码复审实战

0.前言



结对伙伴:顾舒婷

代码地址:Coding.net

1.部分代码示例


#include<stdio.h>
#include<stdlib.h>
#include<string.h>
#include<ctype.h>
void A();//A->V:=E
void E();//E->TE'
void T();//T->FT'
void E1();//E'->+TE'|-TE'|NULL
void T1();//T'->*FT'|/FT'|NULL
void F();//F->V|(E)
void V();//V->a|b|c|d....|z
char s[50],n='1';//s[50]”√”?¥ê∑≈?‰??μ?∏≥÷μ±ì¥??Ω
char Table[50][3]; //≤˙…˙÷–o‰¥˙??à?–?μ?∑?∫≈±ì
int SIGN,sym;//sym??s[50]÷–μ±?∞????∑?∫≈μ???±í
int list_n=0;//∑?∫≈±ìμ???±í
int main()
{
   SIGN=0;
   sym=0;
   scanf("%s",&s);
   if(s[0]=='\0')
   return 0;
   A();
   if(s[sym]!='\0'&&SIGN==0)
   {
      printf("ERROR!\n");
      exit(0);
   }
   return 0;
}

2.代码审查


 

 

 

 

 

 

 

 

 

文件结构
重要性 审查项 结论
头文件和定义文件的名称是否合理?

头文件和定义文件的目录结构是否合理?

版权和版本声明是否完整?

重要 头文件是否使用了 ifndef/define/endif 预处理块?

头文件中是否只存放“声明”而不存放“定义”

程序的版式
重要性 审查项 结论
空行是否得体?

代码行内的空格是否得体?

长行拆分是否得体?

“{” 和 “}” 是否各占一行并且对齐于同一列?

重要 一行代码是否只做一件事?如只定义一个变量,只写一条语句。

重要 If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。

重要 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要?

重要 注释是否有错误或者可能导致误解?

命名规则
重要性 审查项 结论
重要 命名规则是否与所采用的操作系统或开发工具的风格保持一致?

标识符是否直观且可以拼读?

标识符的长度应当符合“min-length && max-information”原则?

重要 程序中是否出现相同的局部变量和全部变量?

类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则?

静态变量、全局变量、类的成员变量是否加前缀?

表达式与基本语句
重要性 审查项 结论
重要 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序?
是否编写太复杂或者多用途的复合表达式?

重要 是否将复合表达式与“真正的数学表达式”混淆?

重要 是否用隐含错误的方式写if语句? 例如
(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。

(2)将浮点变量用“==”或“!=”与任何数字比较。

(3)将指针变量用“==”或“!=”与NULL比较。

  如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判 
  断移到循环体的外面?
重要 Case语句的结尾是否忘了加break?
重要 是否忘记写switch的default分支?
重要 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。
常量
重要性 审查项 结论
  是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串?

在C++ 程序中,是否用const常量取代宏常量? 

重要 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系?
  是否误解了类中的const数据成员?因为const数据成员只在某个对象
  生存期内是常量,而对于整个类而言却是可变的。
函数设计
重要性 审查项 结论
  参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。

  参数命名、顺序是否合理?

  参数的个数是否太多?

  是否使用类型和数目不确定的参数?

  是否省略了函数返回值的类型?

  函数名字与返回值类型在语义上是否冲突?

重要 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。

重要 在函数体的“入口处”,是否用assert对参数的有效性进行检查?

重要 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。

重要 return语句是否返回指向“栈内存”的“指针”或者“引用”?

  是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need”

内存管理
重要性 审查项 结论
重要 用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存)
重要 是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用)
重要 数组或指针的下标是否越界?

重要 动态内存的申请与释放是否配对?(防止内存泄漏)
重要 是否有效地处理了“内存耗尽”问题?
重要 是否修改“指向常量的指针”的内容?
重要 是否出现野指针?例如
(1)指针变量没有被初始化;
(2)用free或delete释放了内存之后,忘记将指针设置为NULL。
重要 是否将malloc/free 和 new/delete 混淆使用?
重要 malloc语句是否正确无误?例如字节数是否正确?类型转换是否正 确?
重要 在创建与释放动态对象数组时,new/delete的语句是否正确无误?
C++ 函数的高级特性
重要性 审查项 结论
  重载函数是否有二义性?

重要 是否混淆了成员函数的重载、覆盖与隐藏?
  运算符的重载是否符合制定的编程规范?
  是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。

原文地址:https://www.cnblogs.com/stupiderman/p/8727073.html

时间: 2024-11-11 16:27:47

代码复审实战的相关文章

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

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

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.反驳.一个人的规范不是规范.一个团队内部的规范也不是代码规范,所有人都遵守的才是代码规范, 总结:代码规范对团队合作很重要.一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码度是不同风格的,即使是分工十分明晰的,等到要整合代码的时候就会很麻烦.别人看你的代码需要很长时间,这样很没有效率.这样去读别人

代码规范、代码复审、PSP

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

结对代码复审结果

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

同伴个人代码复审结果

同伴个人代码复审结果 一.一般性检查 1.代码能够正常运行,基本可以实现预定功能,没有大的逻辑错误. 2.代码结构非常清晰,模块化做得很好,很好地运用了面向对象的编程思想,容易阅读和理解. 3.关于字符串的匹配可以用库函数中的正则表达式来进行,当然可能在字符串比较长的时候,正则表达式会栈溢出,或者效率很低. 4.没有出现多余的调试代码. 5.代码的风格比较规范,缩进.换行.变量命名都遵守一般性的约定. 二.安全性检查 1.对输入的数据格式不合法的情况下,有些时候不能正确地识别. 2.当出现命令行