文档、代码审查管理及解决方案

《文档、代码审查管理及解决方案》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、文档、代码审查文档、代码目录结构4.项目监控5.需求管理6.项目沟通6.1.内部交流6.2.与客户交流7.配置管理第一、文档、代码审查时的要有目的性，针对性。文档、代码审查的根本目的是保证品质，但不能把它做为一次文档、代码审查工作的直接目标，这样的目标太泛泛，让我们在文档、代码审查工作过程中抓不住重点。第二、文档、代码审查工作时参与的角色要合理。参与文档、代码审查工作的人大多是技术合格，但业务不合格，这样对于一些复杂的业务逻辑问题就很难发现，从而使得这些业务逻辑问题在文档、代码审查的过程中蒙混过关。第三、文档、代码审查工作不能过于集中，一次文档、代码审查的代码量

2、太大。在有限的几个小时内，面对上千行，甚至更多的代码时，再有耐心的人也难免产生视觉疲劳。准备要充足，对于要文档、代码审查的缺少必要的审查规范和标准。在文档、代码审查过程中，我们有文档、代码编写规范，代码的设计规范、业务的逻辑规范和标准。那么，我们应该怎样做，才能使文档、代码审查工作保质而且高效呢？一个标准的文档、代码审查工作应该分为三个阶段：　一、事前准备阶段评审规范和标准：在一次文档、代码审查前，掌握代码分析和评审技术、掌握自动化代码分析工具的使用，文档、代码审查产生成本估算，代码文档归档服务器，要懂开发的人员参与文档、代码审查，代码评审以公司内部的文档、代码

3、标准为基础。在文档、代码审查前设计确定评审规范和标准是必要，通过规范和标准我们在审查过程中可以有据可依，有理可循，而且还可以做到标准统一。代码评审的目的：保证文档完善、代码质量、学习和交流，确保参照良好的编码标准，产生高质量，可维护的代码及供参考的文档资料库。二、实施阶段。充分的事前准备，只是做好文档、代码审查工作的前提，文档、代码评审应按照一定的流程作业，这样可以降低评审成本，提高评审效率。代码评审流程介绍如下：1、文档、代码评审发起。代码评审发起要有专门负责人，负责人要控制整个评审过程。负责人负责确定评审范围、评审人、评审结果交付日期和组织召开评审会议。负责

4、人还要编写《代码评审评审点列表》，《代码评审评审点列表》列举出代码评审过程重点检查的项目供评审人逐一检查代码。2、文档、代码审查的对象。在准备文档、代码审查代码对象时，我们要注意代码的数量，如果代码量比较大，要对代码进行必要的分解，确定其中的关键代码，对关键代码进行文档、代码审查，可以达到举一反三的目的。负责人发起代码评审。告知评审人代码的评审范围，确定被评审代码的版本号，告知评审人评审结果的交付时间。负责人还应该为评审人提供相关的资料例如《编码规约》等。3、文档、代码审查内容。我们对代码的审查内容很多，如代码的编写是否规范（注释的书写格式、命名规范等）、技术处

5、理规范（异常处理、日志处理、代码组织结构等）、业务实现等。我们不能希望通过一次文档、代码审查工作，完成所有这些内容的审查，因此我们必须设定本次文档、代码审查工作内容界限，确定审查重点；要做代码静态分析，在不执行的情况下对代码进行评估的过程，类型检查，安全审查，比较静态安全分析工具的最佳方法是使用一些工具分析同一代码并比较其结果。如：命令行参数、配置文件、从数据库中检索出来的数据、环境变量、网络服务、注册表值、临时文件，不要盲目依赖数据库的数据来保证应用程序的正确运行。评审人评审文档、代码。评审人按照负责人告知的评审范围，认真评审代码、文档，填写评审报告，在规定的

6、时间内完成评审。填写评审报告要明确的描述问题发现点的位置，要写清代码文件的版本号，问题点的行号。4、选择文档、代码审查工作的实施方式。文档、代码审查工作有很多形式可供我们选择，我们可以根据实际情况选择桌面式文档、代码审查、演示讲解式文档、代码审查、一对一的座位文档、代码审查等等。负责人将评审结果转交给代码编写人，编写人认真核对评审报告，修正代码。编写人要认真填写评审报告，要写清修正后代码文件的版本号，修正点的行号。5、召开评审会议。会上逐一对评审报告认真分析，评审人和代码编写人要对每一项评审结果达成共识。准确记录。对于文档、代码审查过程发现的问题，我们必须清晰准

7、确的记录，可以使用问题点记录单，明确记录的项目和内容。6、负责人编写评审总结。将评审中总结出的问题和经验通知给项目组成员。并且把完整的所有文档、代码上传到服务器存档，通过版本控制工具来管理（如：SVN、VSS等工具），这样可以有效的共控制文档和代码的完整性，供公司后期参考学习使用三，事后跟踪跟踪。文档、代码审查结束后，对发现的问题，首先需要确定以下内容。　　1．问题点的难易程度以及影响的范围；　　2．解决问题的责任者和问题点修正结果的确认者；　　3．解决问题点的时限。　其次是对于修正问题责任者，在问题点的修正过程中，要三方面内容的记录。　　1．问题点的原因；　　

8、2．解决问题点的对策；