码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • 如何做代码评审?


    引言

            代码评审是指在开发过程中对代码的质量与效率进行检查。代码评审是所有开发团队都应该有的一个行为,在开发过程中定期的检查代码,有助于提前防止架构异变,提前发现隐藏的BUG,完善设计细节。

            代码评审也是个绝佳的学习机会,团队中的个人可以借助这个机会快速的提升自己的研发能力,进而拉高整个研发团队的能力。

    关注点

    • 正确性。代码的变更部分是否与现有架构建立的模式一直?是否存在与现有模式相抵触的地方?是否需要重构代码,或者采用现成的架构模式?设计模式的选取是否合理?
    • 一致性。检查命名。命名是否有意义?是否有晦涩难懂的命名?代码与预期的有多大出入?
    • 可测试性。变更部分是否有清晰的单元测试?每一次构建都通过测试了吗?测试是否存在不充分或者不一致的情况?
    • 可修改性、可维护性。是否有硬编码的情况?代码是否可以变得更灵活?是否引入了新的未通过评审的依赖?注释是否逻辑清晰?日志打印是否合理?
    • 稳定性。异常处理是否前后一致?是否存在错误没有考虑到的情况?是否有重试机制?有没有采用防御性编程的思想?代码是否存在大量占用内存的可能性?算法是否高效?是否在适当的时候使用了线程安全的数据结构?

    标准步骤

    1. 确定参与者,并且提前给出需要评审的代码,告知到所有参与者,提前熟悉代码逻辑。
    2. 通过远程会议、邮件、面谈的方式组会,持续时间不宜过长,一般控制在30分钟以内,可以跟团队人员做好约定定期开展。。
    3. 快速阅读变更集,对变更范围形成整体印象。
    4. 各参会人员发表意见,重点检查设计细节、代码风格、缺陷,并做好相关记录。
    5. 自由讨论时间,通常架构级别的问题需要评审结束后进一步单独组会讨论。
    6. 回顾评审结果,确定修改内容与截止日期。

    建议

    1. 每次代码评审时间不宜过长,30分钟以内。
    2. 每次代码评审的量不宜过大,千行以内。
    3. 尽量借助Git等版本控制工具。
  • 相关阅读:
    大学生静态HTML鲜花网页设计作品 DIV布局网上鲜花介绍网页模板代码 DW花店网站制作成品 web网页制作与实现
    中国信息通信研究院发布《中国金融科技生态白皮书》(2023)
    FPGA时序约束01——基本概念
    SpringCloud + SpringGateway 解决Get请求传参为特殊字符导致400无法通过网关转发的问题
    数据结构之顺序表
    MindSpore进阶课程视频集锦
    vite项目require语法兼容问题解决require is not defined
    flutter 命令
    每天一个数据分析题(三百九十七)- 逻辑回归
    MYSQL函数,一篇文章看完!
  • 原文地址:https://blog.csdn.net/qq_33121481/article/details/126128805
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号