`

什么是代码复查

阅读更多

代码复查(Code Review),又叫“代码审查”,其基本思想就是,在开发人员编写完自己的代码后,由其他人来复查

他写的代码,从而有效地发现代码中存在的缺陷。代码复查的一个基本理论就是,当我们越早发现代码存在的缺陷,我们解决

缺陷的代价就越低。代码复查往往分成以下一个方面进行审查:

1)代码风格。在项目开发之初,我们往往会制定一个代码编写的规范,实际上,这个代码规范就包含了整个项目组的

代码风格。由于软件开发人员的设计习惯不同,如果不统一代码风格,一个项目中的代码将五花八门,如变量和常量的命名、

接口与实现类的注释、何时回车、怎样缩进等等。一个五花八门的设计风格,必将为日后的维护与改进带来困难。我们通过代

码复查,一方面督促开发人员按照规范编写代码,另一方面也使开发人员自身形成良好的编程习惯。代码风格的审查,由于内

容比较单一,我们常常可以通过一些代码复查的工具来自动完成,提高复查的效率。

2)重大缺陷。在一些关于代码复查的文章中,列出了一个常常的单子,描述了代码复查应当着重注意的重大缺陷,它

们包括:存在SQL注入、易受跨站点脚本攻击、缓存区溢出、托管代码等等。项目组可以不断积累重大缺陷的审查项目,并在

每次审查中逐一检查。重大缺陷审查是一个繁琐而细致的工作,如果能编写或使用一些审查软件,可以大大提高我们的审查效

率。

3)设计逻辑与思路的审查。我认为,这部分的审查是代码复查中最核心、最有价值的部分。代码风格与重大缺陷的审

查,虽然重要但简单而机械,可以通过软件自动检查;而设计逻辑与思路的审查,却是复杂而有深度的审查,需要有一定理论

深度和编码经验的人才能完成,而且对新手尤其重要。前面提到,新手是任何项目组不可避免的问题。但遗憾的是,许多项目

经理的办法是,只将一些简单而少量的工作交给新手完成,而将大量复杂的工作交给人数不多的那些老手来完成。这样的结果

是,新手始终是新手,他们没有经过足够的锻炼;老手累死累活,无法指望新手予以分担工作。对于这个问题,我的办法是,

通过代码复查,让老手去指导新手,让团队整体素质达到提高。具体办法就是,在新手完成编码以后,让老手去进行代码复

查,指出新手的问题,指导新手设计。这样的过程最初可能需要重构,甚至重新编码。但经过这样的过程,新手将逐渐熟练,

迅速成为老手,使整体团队素质提高。

分享到:
评论

相关推荐

    如何提高代码质量(管理篇):代码复查

    代码复查是确保代码质量的重要手段,它是一种同行评审过程,旨在发现并修复潜在的错误、不一致性和设计问题。本篇文章将探讨如何通过有效的代码复查来提升代码质量,同时结合源码管理和工具的应用。 首先,代码复查...

    JAVA代码复查工具使用指南.pdf

    ### JAVA代码复查工具使用指南知识点解析 #### 一、概述 - **目的**: 本指南旨在为Java开发者提供一套标准化的代码复查流程,通过使用特定的工具来提高代码质量和可维护性。它不仅有助于发现潜在的错误和不规范的...

    JAVA代码检查表--用来评审java代码

    公司目前使用的java代码检查表,提供出来供大家参考

    JSP+Servlet简单新闻管理系统,无复查UI代码,简洁,代码可读性高!

    强调代码“难度低”和“可读性高”,意味着这个项目对初学者或者希望了解基础Web开发的人十分友好,他们可以轻松地阅读和理解代码,进而学习和实践。 【标签解析】 标签"java"、"servlet"、"jsp"直接对应了该项目的...

    Seay源代码审计系统.rar

    7. **持续审计**:代码审计不是一次性的工作,而是应该贯穿于整个项目开发周期,定期使用Seay进行代码复查,确保代码质量和安全性。 总之,Seay源代码审计系统通过其丰富的功能和强大的自动化审计能力,为开发者...

    外交学院研究生入学考试成绩复查申请表.pdf

    此表格是申请复查的第一步,其中包含了关键信息,如考生的姓名、准考证号、复查的科目代码及名称,以及原成绩等。这些信息务必准确无误,以便于校方核实考生身份和对应科目。 在“申请复查理由及复查重点”一栏,...

    浅析框架与代码规范.pdf

    对于抽查不合格的情况,需要进行复查。 4. **错误反馈机制:**与新员工一样,老员工在开发过程中出现违反代码规范的行为也会受到批评和指导,以确保团队的整体代码质量不受影响。 ### 实施代码规范的关键点 为了...

    移除代码注释 软著代码材料

    值得注意的是,虽然自动化工具可以大大提升效率,但并非所有类型的注释都能被完美处理,因此人工复查通常是必要的。 总结来说,这个场景涉及到了软件著作权申请中的一个重要环节——清理代码注释。`nccode.exe`和`...

    如何阅读源代码

    对于这些需求的理解,能够让我们意识到,为什么在某些地方代码的实现方式会有所不同。例如,在性能要求极高的场景下,可能就会使用一些特殊的算法和数据结构来优化性能。 在处理现有的代码时,与作者或维护者进行...

    Seay源代码审计系统2.1

    此外,尽管该工具能够辅助进行源代码审计,但人工复查和理解上下文仍然是不可或缺的步骤,以确保所有潜在问题都得到充分考虑。 在实际应用中,Seay源代码审计系统2.1可广泛应用于软件开发公司、网络安全团队以及...

    JupiterUsage

    ### 代码复查利器:Jupiter使用详解 #### 引言 在软件开发过程中,代码复查是确保代码质量、提升团队协作效率的关键环节。Jupiter,作为一款专为Eclipse用户设计的代码复查工具,以其简洁高效的特点,在软件工程...

    代码审计方案.doc

    代码审计实施流程主要分为四个阶段,包括代码审计前期准备阶段、代码审计阶段实施、复查阶段实施以及成果汇报阶段。在实施代码审计工作前,技术人员会和客户对代码审计服务相关的技术细节进行详细沟通。然后,技术...

    优美代码力作

    【代码复查】是提升代码质量的有效途径。让同事或朋友审查你的代码,可以从不同角度发现潜在问题,促进团队间的知识共享和技能提升。 【代码风格】的统一也很重要,如保持适当间距,统一命名规则,合理组织var语句...

    全国投资项目在线审批监管平台(广东)项目统一代码申请操作手册.pdf

    完成所有信息填报后,仔细复查无误; b. 核对提交的材料,确认无漏项; c. 正式提交申请,等待审批结果。 5. 等待审核和反馈 a. 在提交申请后,需耐心等待审批监管平台的审核; b. 审核过程中可能会有需要补充...

    代码审查规范方案标准[详].doc

    代码审查的步骤包括编写者与审核者共同讨论代码逻辑,审核者随时提问,记录并修正问题,然后审核者进行深入的代码复查,编写“审核结果”并提交至版本控制系统。代码编写者根据审核意见进行修改。 这样的代码审查...

    缺陷查找技术PPT学习教案.pptx

    为了有效地利用代码复查,应当在第一次编译前进行,这可以节省编译时间并避免因已知错误而影响复查质量。复查时应记录发现的每一个缺陷,并根据之前的编译和测试经验来检查可能的错误类型。 此外,通过收集编译和...

    RF-GC-ZY-01-F04 整改复查申请表(甲指分包)(1).zip

    首先,"RF-GC-ZY-01-F04"可能是项目的内部编号或代码,用于区分不同的文档和流程。这种编码方式在项目管理中很常见,便于管理和追踪。"整改复查申请表"则意味着这个文档是关于检查过程中发现的问题整改后,进行复查...

Global site tag (gtag.js) - Google Analytics