《2022年怎样作好代码审查参考 .pdf》由会员分享，可在线阅读，更多相关《2022年怎样作好代码审查参考 .pdf（5页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、知识库文件BT_SP_OPD_T20-内部资料，注意保密- 第 1 页 共 5 页怎样做好代码审查文件状态 草稿 正式发布 正在修改当前版本V1.0 拟 制日期2011-11-29 审 核日期目录怎样做好代码审查. 1名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 5 页 - - - - - - - - - 知识库文件BT_SP_OPD_T20-内部资料，注意保密- 第 2 页 共 5 页1编写目的 . 32应用范围和适用对象 . 33参考资料 . 34关键字 . 35怎
2、样做好代码审查. 35.1常见问题 . 35.2代码评审过程 . 4名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 5 页 - - - - - - - - - 知识库文件BT_SP_OPD_T20-内部资料，注意保密- 第 3 页 共 5 页1 编写目的本文主要分析了代码审查常见问题, 并给出相应的解决方案 . 2 应用范围和适用对象可供项目开发、管理及质量保证人员参考。3 参考资料无4 关键字代码审查5 怎样做好代码审查5.1 常见问题我们把代码审查叫做CR，即 Cod
3、e Review。它是项目进展到编码阶段非常重要的品质保证活动。但是很多时候，我们的CR 工作都流于形式，在CR 过程中不能发现本质问题，主要有以下四点原因：一， CR 时的目的性不强，缺乏针对性。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 5 页 - - - - - - - - - 知识库文件BT_SP_OPD_T20-内部资料，注意保密- 第 4 页 共 5 页CR 的根本目的是保证品质，但不能把它做为一次CR 活动的直接目标，这样的目标太泛泛，让我们在CR 活动
4、过程中抓不住重点。二， CR 活动时参与的角色不合理。参与 CR 活动的人大多是技术合格，但业务不合格， 这样对于一些复杂的业务逻辑问题就很难发现，从而使得这些业务逻辑问题在CR 的保护伞下，堂而皇之的蒙混过关。三， CR 活动过于集中，一次CR 的代码量太大。在有限的几个小时内，面对上千行， 甚至更多的代码时，再有耐心的人也难免产生视觉疲劳。四，准备不足，对于要CR 的代码缺少必要的审查规范和标准。在代码审查过程中，我们往往只有代码编写规范，但是代码的设计规范、业务的逻辑规范和标准等准备不足。5.2 代码评审过程那么，我们应该怎样做，才能使CR 工作保质而且高效呢？一个标准的CR 活动应该分
5、为三个阶段：一，事前准备阶段。在一次 CR 前，以下对以下内容进行充分准备。1CR 的对象。在准备CR 代码对象时，我们要注意代码的数量，如果代码量比较大，要对代码进行必要的分解，确定其中的关键代码，对关键代码进行CR，可以达到举一反三的目的。2CR 内容。我们对代码的审查内容很多，如代码的编写是否规范（注释的书写格式、命名规范等）、技术处理规范（异常处理、日志处理、代码组织结构等）、业务实现等。我们不能希望通过一次CR 活动，完成所有这些内容的审查，因此我们必须设定本次CR 活动内容界限，确定审查重点；3评审规范和标准。在CR 前设计确定评审规范和标准是必要，通过规范和标准我们名师资料总结
6、- - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 5 页 - - - - - - - - - 知识库文件BT_SP_OPD_T20-内部资料，注意保密- 第 5 页 共 5 页在审查过程中可以有据可依，有理可循，而且还可以做到标准统一。4选择 CR 活动的参与者。 在 CR 开始前， 必须把本次CR 活动的对象、 审查内容以及审查的规范和标准通报给所有的参与者。5选择 CR 活动的实施方式。CR 活动有很多形式可供我们选择，我们可以根据实际情况选择桌面式CR、演示讲解式CR、一对一的座位
7、CR 等等。二，实施阶段。充分的事前准备，只是做好 CR 活动的前提， 在 CR 实施过程中， 我们要做好以下工作。1准确记录。对于CR 过程发现的问题，我们必须清晰准确的记录，可以使用问题点记录单，明确记录的项目和内容。2CR 过程中，要采用代码作者讲解和审查者提问方式。审查者不能只在发现问题时提问，同时也要根据本次审查的内容要求代码作者对某个特定问题的讲解。3对事前确定的审查内容，要逐项审查，不能因为时间不足等因素一扫而过。4实施审查时，要营造一个讨论问题、解决问题的氛围，不能把审查会搞成批判会，这样会影响相关人员的积极性。三，事后跟踪。CR 结束后，对发现的问题，首先需要确定以下内容。1问题点的难易程度以及影响的范围；2解决问题的责任者和问题点修正结果的确认者；3解决问题点的时限。其次是对于修正问题责任者，在问题点的修正过程中，要三方面内容的记录。1问题点的原因；2解决问题点的对策；3修正的内容。做为修正结果的确认者，必须按照事前约定的时限及时的对修正结果进行全面的确认。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 5 页 - - - - - - - - -