`

代码审查最佳实践

 
阅读更多

1. 每天进行代码审查

能坚持做代码审查的企业,多数都以1~3天为基本审查间隔。

个人感觉每天代码审查最好,因为代码量少,思路连续,师傅不至于问徒弟“这是什么”。

某些企业选择“某个功能完成后”做代码审查,也是一个思路,因为只要审核这个功能的代码,思路也是相对连续。但这些功能不宜太大。

思路连续,能快速看完,是这个实践的价值观。

2. 师傅给徒弟看

个人最喜欢的搭配,有责任感,搭配稳定效率高,发现的问题也很少有争议,而且顺便能教徒弟一些东西,之前之五中曾经提到过。

某些团队采用互相看代码,或随便谁看代码,这容易产生争议,或水平相当的人看不出别人的问题,从而降低效率。

责任感,能快速发现问题,有知识传递,是这个实践的价值观。

3. 每人每天看5分钟

听过各种长度的审查,越长越难以坚持。很多超长的代码审查,是因为“每个月审查一次”,而正是因为每个月审查一次,审查才超长,而效率更是变得低下,因为很多代码看不懂了。所以,很多时候时间长不等于看得仔细,而是等于看不懂。

个人最喜欢的是每个徒弟每天最多看5分钟,只解决一眼看到的最关键问题。下面会讲剩下的问题怎么办。

如果每天都看,而且从第一天就开始看,徒弟的代码里边很少会堆积一大堆“关键问题”问题,除非1、2没做好。

时间短才能坚持每天做,是这个实践的价值观。

4. 每次只看1个重要缺陷

有时候很多人尝试一次把所有缺陷都看出来,结果是,每次都看出很多缺陷,而缺陷又层出不穷。原因是当试图解决很多缺陷时,徒弟往往无法记住,也无法再下次避免,结果师傅就变成了徒弟的“代码审查员”。

所以,无论缺陷多少,只解决1个最重要的,比如空指针,野指针,数组越界……等等,但每次解决后,都要帮助徒弟彻底解决,并能在以后避免。

彻底解决和避免缺陷,是这个实践的价值观。

5. 今后……(不要再看到这个缺陷)

授之以鱼不如授之以渔,师傅发现问题,就要讲透。

比如我们当年对待空指针(C++),就三条:一个指针要尽早等于一个值(延迟声明),如果实在不能就等于空;一个指针使用前必须检查是否为空;一个指针删除后必须置为空。不但要帮助徒弟发现缺陷,还要告诉他如何永久避免,才能防止日后再次看到这个缺陷。

彻底解决和避免缺陷,是这个实践的价值观。

6. 之前……(是不是也有这类问题?)

如果从第一天就看代码,这个问题就不太重要了。

如果中间才开始看的,那么要求徒弟在闲暇的时候把以前的代码都看一遍,顺便都改好。

这样就解放了师傅的时间,而且我发现多数程序员在发现学到了一个新方法后,都很乐于到以前代码里边试验一下;可能是因为以往的时候总是被程序欺负,而现在终于可以回去报复一下了。

提高徒弟水平,解放师傅时间,是这个实践的价值观。

7. 师兄带师弟

有两层含义,一层是说代码审查发现问题,要讲什么理论的时候(比如前面说的指针用法),尽量多喊几个徒弟来,一起听;二层是说如果不幸后来又来了新徒弟犯了老问题,可以请听过这个事情的师兄来给他讲。

提高徒弟水平,解放师傅时间,是这个实践的价值观。

分享到:
评论

相关推荐

    代码审查CodeReview的最佳实践

    我一直认为CodeReview(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题。包括像Google、微软这些公司,CodeReview都是基本要求,代 我一直认为CodeReview(代码...

    代码审查表和代码审查实例

    代码审查是软件开发过程中的重要环节,它有助于提高代码质量,发现潜在的错误,以及确保遵循最佳实践。在Java编程中,代码审查同样至关重要,因为Java作为一种广泛应用的面向对象语言,其复杂性和广泛性需要严谨的...

    软件工程中的代码审查与质量保证.pptx

    #### 第四章:代码审查最佳实践 - **准备阶段**:明确代码审查的目标、选择合适的工具、编写清晰的文档。 - **审查过程**: - **代码规范**:遵循一致的代码风格指南。 - **同行评审**:鼓励团队成员之间的相互...

    presentation-CRADE:挑战代码审查最佳实践的研讨会 [SudWeb 2013]

    “CRADE”可能是“Code Review And Development Environment”的缩写,这是一个针对代码审查和开发环境的研讨会,特别关注如何挑战现有的最佳实践。这个活动在"SudWeb 2013"举行,这可能是一个技术会议或者开发者...

    Git:代码审查与Git最佳实践.docx

    Git:代码审查与Git最佳实践.docx

    火爆,Github标星240K的编程学习路线图,适合所有程序员!

    推荐一个涵盖开发、运维、产品设计的学习路线图,在Github已经start超过240K,包括各门编程语言! 该项目涵盖了非常全面的学习路线图: ...代码审查最佳实践 前端性能最佳实践 API 安全最佳实践 AWS 最佳实践

    Best Practices For Peer CodeReview

    ### 同行代码审查最佳实践 #### 引言 在软件开发过程中,同行代码审查(Peer Code Review)是一项被广泛采用的关键活动。它不仅能够帮助识别潜在的缺陷、提高代码质量,还能促进团队间的协作与知识共享。然而,...

    静态测试方法之代码审查(CodeReview)的清单

    下面列出的这些要点因该可以作为大部分代码审查的指导,如果是Java应用的话,这些建议应该被视作最佳实践。  代码审查可以帮助提高代码质量,避免由于代码习惯而造成的bug。下面列出的这些要点因该可以作为大部分...

    Best Practise for Peer Code Review

    ### 同行代码审查最佳实践 #### 概述 代码审查是软件开发过程中不可或缺的一环,它能够帮助团队发现潜在的缺陷、提高代码质量并促进团队成员之间的协作与学习。同行代码审查作为软件工程中的一个关键环节,对于...

    Java代码审查工具

    Java代码审查工具是提高软件质量和团队协作效率的重要手段。代码评审是一种系统性的源代码检查过程,旨在确保...定期进行代码审查,结合持续的教育和最佳实践分享,可以帮助团队保持代码的高质量,降低后期维护成本。

    软件工程中的代码审查实践与经验.pptx

    ### 软件工程中的代码审查实践与经验 #### 第一章:软件工程概述 - **定义**:软件工程是一种采用系统化、规范化且可度量的方法来开发和维护软件的学科。 - **目标**: - 提升软件质量 - 增加生产效率 - 降低...

    淘宝编码最佳实践 编码规范

    8. **代码审查**:鼓励团队成员之间进行代码审查,以发现潜在问题,分享知识,提升整体代码质量。 9. **性能优化**:在编码阶段就应考虑到性能问题,避免不必要的计算,优化数据结构和算法,合理利用缓存,减少IO...

    java代码审查.pdf

    中的知识点之前,需要明确这两个字段提供的是文件名和文件内容的描述,它们分别指出了文档的主题是关于Java代码审查的PDF文档,以及文档内容涉及到了Java编程语言中的代码审查技巧、bug修复、代码风格、最佳实践等...

    ASP.NET项目开发全程实录第3版(附带代码)

    10. **代码管理与团队协作**:介绍版本控制工具(如Git),以及团队开发中的协作和代码审查最佳实践。 通过本书的实录项目,读者将有机会实践上述知识点,从创建基本页面到构建复杂业务逻辑,逐步提升ASP.NET开发...

    Best practices in code inspection for safety-critical software

    ### 安全关键软件代码审查最佳实践 在当今数字化时代,计算机系统越来越多地监督和控制安全关键系统,逐渐取代了传统的故障安全硬件技术。这些系统不仅关乎财产与环境的安全,更重要的是保障个体的生命安全。然而,...

    修改软件的艺术:构建易维护代码的9条最佳实践

    代码审查也是传播最佳实践和团队知识的重要手段。 9. 持续重构:随着项目发展,代码可能变得复杂。定期进行重构,以保持代码的简洁性和可读性,是保持代码可维护性的关键。 以上9条最佳实践旨在指导开发者创建易于...

    「安全研究」安全代码审查-S-SDLC与安全代码审查 - 安全意识.zip

    安全代码审查是软件开发生命周期(Software Development Life Cycle, SDLC)中的一个重要环节,它与数据安全密切相关,旨在发现并修复程序中的潜在安全漏洞,从而提高软件的安全性。在这个主题中,我们将深入探讨...

    轻量级代码审查工具 JavaViwer1.0说明书

    JavaViewer 1.0 的设计模型可能基于软件工程中的最佳实践,如: 1. **模块化**:工具各功能模块相互独立,便于维护和扩展。 2. **面向对象**:利用Java的面向对象特性,实现代码的封装、继承和多态。 3. **可配置性*...

    代码审查:追求有效和高效的敏捷代码审查

    5. **定期培训**:组织关于最佳实践和新工具的培训,提升团队的整体审查能力。 在敏捷环境中,代码审查需要与敏捷原则相结合,如持续集成和持续交付(CI/CD)。这要求审查过程快速且有针对性,避免阻塞开发进度。...

    代码审查表1

    代码审查是软件开发过程中的一个重要环节,它有助于提高代码质量,发现潜在的错误,以及确保遵循最佳实践。本文将详细探讨“代码审查表1”所涉及的各个方面,并提供相关知识点。 1. **代码审查的目的**: - 提升...

Global site tag (gtag.js) - Google Analytics