一、概述
代码审查(Code Review)是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。
1.1主要工作
1、发现代码中的bug;
2、从代码的易维护性、可扩展性角度考察代码的质量,提出修改建议。
3、是否符合java开发规范和代码审核检查表
1.2 基本流程
1、代码编写者和代码审核者坐在一起,由代码编写者按照UC(Use Case)依次讲解自己负责的代码和相关逻辑,从表现层->持久层;
2、代码审核者在此过程中可以随时提出自己的疑问,同时积极发现隐藏的bug;对这些bug记录在案。
3、代码讲解完毕后,代码审核者给自己安排几个小时再对代码审核一遍。 代码需要一行一行静下心看。同时代码又要全面的看,以确保代码整体上设计优良。
4、代码审核者根据审核的结果编写“代码审核报告”,“审核报告”中记录发现的问题及修改建议,然后把“审核报告”发送给相关人员。
5、代码编写者根据“代码审核报告”给出的修改意见,修改好代码,有不清楚的地方可积极向代码审核者提出。
6、代码编写者 bug fix完毕之后给出反馈。
7、代码审核者把Code Review中发现的有价值的问题更新到"代码审核检查表"的文档中,对于特别值得提醒的问题可群发email给所开发人员。
1.3 责任
代码编写者,代码审核者共同对代码的质量承担责任。这样才能保证Code Review不是走过场,其中代码编写者承担主要责任,代码审核者承担次要责任。
二、java代码审查检查表
重要性
|
激活
|
级别
|
检查项
|
总计
|
|
|
|
命名
|
|
|
|
重要
|
|
20
|
命名规则是否与所采用的规范保持一致?
|
|
|
20
|
是否遵循了最小长度最多信息原则?
|
重要
|
|
50
|
has/can/is前缀的函数是否返回布尔型?
|
注释
|
|
|
|
重要
|
|
10
|
注释是否较清晰且必要?
|
重要
|
Y
|
10
|
复杂的分支流程是否已经被注释?
|
|
|
10
|
距离较远的}是否已经被注释?
|
|
|
10
|
非通用变量是否全部被注释?
|
重要
|
Y
|
50
|
函数是否已经有文档注释?(功能、输入、返回及其他可选)
|
|
|
10
|
特殊用法是否被注释?
|
声明、空白、缩进
|
|
|
|
|
|
20
|
每行是否只声明了一个变量?(特别是那些可能出错的类型)
|
重要
|
|
40
|
变量是否已经在定义的同时初始化?
|
重要
|
|
40
|
类属性是否都执行了初始化?
|
|
|
20
|
代码段落是否被合适地以空行分隔?
|
|
Y
|
20
|
是否合理地使用了空格使程序更清晰?
|
|
|
20
|
代码行长度是否在要求之内?
|
|
|
20
|
折行是否恰当?
|
语句/功能分布/规模
|
|
|
|
|
|
20
|
包含复合语句的{}是否成对出现并符合规范?
|
|
|
20
|
是否给单个的循环、条件语句也加了{}?
|
|
|
20
|
if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范?
|
|
|
40
|
单个变量是否只做单个用途?
|
重要
|
|
20
|
单行是否只有单个功能?(不要使用;进行多行合并)
|
重要
|
|
40
|
单个函数是否执行了单个功能并与其命名相符?
|
|
Y
|
20
|
操作符++和— —操作符的应用是否复合规范?
|
规模
|
|
|
font-size:
分享到:
Global site tag (gtag.js) - Google Analytics
|
相关推荐
Java代码审查表重要性激活级别检查项结论总计命名重要性规则 一、代码命名规则 Java代码审查表中关于命名规则的重要性激活级别检查项有: * 命名规则是否与所采用的规范保持一致?(重要20) * 变量是否已经在...
Java代码审查工具是提高软件质量和团队协作效率的重要手段。代码评审是一种系统性的源代码检查过程,旨在确保代码符合编程标准,减少错误,提高可维护性和可读性,同时也能促进团队成员之间的知识共享。在这个过程中...
### Java代码审查重要知识点 #### 一、概述 **代码审查(Code Review)**是软件开发过程中一个重要的环节,它有助于在代码被正式集成之前发现并修复潜在的问题和缺陷。这一过程通常涉及多名团队成员,旨在提高代码...
在详细说明【标题】及【描述】中的知识点之前,需要明确这两个字段提供的是文件名和文件内容的描述,它们分别指出了文档的主题是关于Java代码审查的PDF文档,以及文档内容涉及到了Java编程语言中的代码审查技巧、bug...
Code Review是一种用来确认方案设计和代码实现的质量保证机制,通过这个机制我们可以对代码、测试过程和注释进行检查。 Code Review主要用来在软件工程过程中改进代码质量,通过Code Review可以达到如下目的: .在...
JAVA代码审查[整理].pdf
Java代码审查是软件开发流程中不可或缺的一环,旨在提高代码质量、减少错误并增强团队协作。根据提供的文件信息,我们可以深入探讨代码审查的关键知识点及其在Java项目中的具体应用。 ### 代码审查的重要性 代码...
Java 代码审查清单 一、代码整洁清单项分类 1. 使用有意义的名称:变量、函数和类名应该能够表达实际意图,使用描述性名称,避免使用单个字符或缩写。 2. 函数只做一件事:函数应该只有一个明确的任务,避免函数过...
- **范围**:针对Java代码审查流程,适用于所有参与系统开发的团队成员,包括技术负责人、后端开发、测试人员和运维人员。 - **读者对象**:适用于所有参与系统开发的团队成员,旨在指导他们的代码审查工作。 2. ...
最后,实际的代码审查实例,如java代码审查表.doc,提供了具体的审查案例,可以帮助开发者了解如何进行实际的审查工作,以及审查时应关注的细节。通过学习这些实例,开发者可以更好地理解如何将理论知识应用到实践中...
接下来,Java代码审查表是一种用于确保代码质量的工具。它可能包含了一系列标准和最佳实践,例如遵循一定的命名规范、避免使用全局变量、确保适当的异常处理、使用注释来提高代码可读性等。通过定期进行代码审查,...
Java代码审查是一种确保代码质量、提高软件可靠性和可维护性的关键过程。一个有效的Java审查表可以帮助开发者遵循最佳实践,减少错误,并确保代码符合团队或项目的编码标准。以下是一些基于提供的Java审查表的关键...
java代码评审检查表:包含java常用代码审查内容
公司目前使用的java代码检查表,提供出来供大家参考
本文将从给定的部分内容出发,深入分析Java代码审查中需要注意的一些常见错误,并给出相应的解决方案。 #### 1. NullPointerException (空指针异常) **描述**:`NullPointerException`通常发生在试图访问一个null...
在Java项目开发中,代码审查(Code Review)是确保代码质量、遵循最佳实践以及提高团队协作效率的关键步骤。本文档将深入探讨在Code Review过程中常见的问题,并提供实例分析,以帮助开发者避免这些问题。 **第一章...
JavaViewer 1.0 是一款专为Java源代码审查设计的轻量级工具,旨在提高代码审查效率并降低审查成本。这款工具集成了多种功能,为开发者提供了全面、高效的代码检查环境。 一、软件特点 JavaViewer 1.0 的主要特点...
java,代码审查标准
### Java源代码审查规范知识点详解 #### 一、目的与范围 **目的:** - 统一编码习惯:确保所有开发人员遵循相同的编码规范,提高程序的质量和一致性。 - 提高可读性与可维护性:使代码更容易理解和维护,减少后期...
Java 代码审查检查清单 Java 是一种广泛使用的编程语言,用于开发各种应用程序。为了确保 Java 代码的质量和可靠性,代码审查是一个非常重要的步骤。代码审查可以帮助开发者发现和修复错误,提高代码的可读性和可...