搜索

[24149] 2015-07-31_代码审查的5点经验教训总结

文档创建者：s7ckTeam
浏览次数：3
最后更新：2025-01-18
2015-07-31_代码审查的5点经验教训总结 代 码 审 查 的 5 点 经 验 教 训 总 结 L i n u x 中 国   2 0 1 5 - 0 7 - 3 1 我 们 时 常 会 听 到 团 队 成 员 说 ： “ 这 个 项 目 搞 代 码 审 查 简 直 是 在 浪 费 时 间 。 ” “ 我 没 时 间 做 代 码 审 查 。 ” “ 发 布 会 延 迟 ， 是 因 为 我 那 个 卑 鄙 的 同 事 还 没 有 审 查 过 我 的 代 码 。 ” “ 你 能 相 信 我 的 同 事 居 然 要 求 我 改 我 的 代 码 吗 ？ 我 这 么 优 雅 完 美 的 代 码 哪 里 还 需 要 改 呢 。 ” 我 们 为 什 么 要 做 代 码 审 查 ？ 任 何 专 业 的 软 件 开 发 人 员 其 最 重 要 的 目 标 之 一 就 是 要 不 断 提 高 自 己 的 工 作 质 量 。 但 是 只 有 团 队 协 作 才 能 力 往 一 处 使 ， 劲 往 一 处 用 ， 提 高 软 件 质 量 。 代 码 审 查 是 实 现 这 一 目 标 最 重 要 的 途 径 之 一 。 特 别 是 ， 代 码 审 查 可 以 ： 从 另 一 个 角 度 发 现 缺 陷 和 更 好 的 解 决 办 法 。 确 保 至 少 另 外 还 有 一 人 熟 悉 你 的 代 码 。 通 过 翻 阅 资 深 开 发 人 员 的 代 码 ， 帮 助 培 训 新 员 工 。 促 进 知 识 共 享 。 激 励 开 发 人 员 更 好 地 写 代 码 、 解 决 代 码 中 的 问 题 ， 以 免 在 审 查 时 被 别 人 揪 出 来 。 代 码 审 查 要 彻 底 然 而 ， 除 非 能 实 实 在 在 彻 彻 底 底 地 在 代 码 审 查 上 花 时 间 和 精 力 ， 否 则 上 述 目 标 是 很 难 实 现 的 。 我 的 看 法 是 大 概 2 5 ％ 的 原 始 开 发 时 间 应 该 花 在 代 码 审 查 上 。 举 个 例 子 ， 如 果 一 个 开 发 人 员 需 要 用 两 天 时 间 来 实 现 某 个 程 式 ， 那 么 就 应 该 花 大 约 4 小 时 进 行 审 查 。 当 然 时 间 并 不 是 最 重 要 的 ， 关 键 是 要 看 你 能 否 正 确 审 查 代 码 。 你 必 须 了 解 你 正 在 审 查 的 代 码 。 这 意 味 着 你 不 仅 仅 要 知 道 它 的 的 语 法 ， 还 必 须 理 解 代 码 是 如 何 融 入 应 用 程 序 这 个 大 环 境 下 ， 成 为 组 件 或 库 的 一 部 分 。 如 果 你 不 能 把 握 每 一 行 代 码 的 含 义 ， 那 么 你 的 审 查 就 不 到 位 ， 也 不 会 非 常 有 价 值 。 这 也 是 为 什 么 良 好 执 行 的 代 码 审 查 ， 大 多 不 可 能 迅 速 被 完 成 ： 因 为 我 们 需 要 时 间 来 研 究 各 种 代 码 ， 如 能 触 发 给 定 功 能 以 确 保 第
三 方 A P I 正 确 使 用 的 代 码 。 r e v i e w - 5 - t i p s - 0 2 在 审 查 时 ， 除 了 要 寻 找 代 码 缺 陷 和 其 他 问 题 ， 你 还 应 该 确 保 ： 囊 括 所 有 必 要 的 测 试 。 已 经 写 入 了 恰 当 的 设 计 文 档 。 即 使 是 那 些 擅 于 写 测 试 和 文 档 的 开 发 人 员 ， 也 会 在 改 变 代 码 的 时 候 忘 记 更 新 。 代 码 评 审 时 就 应 该 确 保 这 些 资 料 不 会 随 着 时 间 而 变 得 毫 无 用 处 。 避 免 过 度 的 代 码 审 查 开 发 人 员 应 该 努 力 清 空 积 压 的 审 查 任 务 。 有 一 种 方 法 是 在 早 上 代 码 审 查 ， 在 开 始 自 己 的 开 发 工 作 之 前 先 搞 定 审 查 任 务 。 当 然 你 也 可 以 午 饭 前 后 或 者 是 一 天 结 束 之 时 审 查 代 码 。 总 而 言 之 ， 你 应 该 将 代 码 当 作 是 日 常 工 作 的 一 部 分 ， 而 不 是 工 作 的 负 累 ， 所 以 你 应 该 避 免 ： 没 有 时 间 处 理 积 压 的 审 查 任 务 。 由 于 审 查 的 没 有 完 成 而 导 致 了 延 迟 发 布 。 傻 乎 乎 地 再 去 审 查 已 经 不 相 干 的 代 码 ， 在 交 给 你 之 后 已 经 被 改 的 面 目 全 非 。 因 为 时 间 紧 迫 急 急 忙 忙 地 走 个 过 场 。 编 写 可 审 查 的 代 码 出 现 代 码 积 压 而 失 控 的 问 题 ， 审 查 人 员 并 不 是 唯 一 一 个 需 要 负 责 的 人 。 举 个 例 子 ， 如 果 你 的 同 事 花 了 一 周 时 间 为 一 个 大 型 程 序 添 加 了 乱 七 八 糟 的 代 码 ， 那 么 发 布 的 补 丁 就 会 变 得 很 难 审 查 ， 有 太 多 的 内 容 需 要 理 解 和 钻 研 。 甚 至 于 连 代 码 目 的 和 基 本 架 构 都 看 得 云 里 雾 里 。 这 是 写 代 码 的 不 是 。 在 编 写 可 审 查 的 代 码 之 前 ， 还 需 要 做 一 些 准 备 。 如 果 需 要 做 一 些 棘 手 的 架 构 决 策 ， 那 么 最 好 和 审 查 人 员 先 讨 论 一 番 。 这 将 能 让 你 的 代 码 更 容 易 审 阅 和 理 解 ， 因 为 他 们 提 前 已 经 知 道 你 想 实 现 什 么 以 及 计 划 如 何 实 现 。 这 也 可 以 避 免 ， 要 是 审 查 人 员 之 后 提 出 一 个 截 然 不 同 又 更 好 的 方 法 ， 而 导 致 你 不 得 不 重 写 一 大 片 代 码 的 情 况 。 项 目 架 构 应 该 在 设 计 文 档 中 详 细 描 述 。 这 很 重 要 ， 因 为 它 能 让 新 的 项 目 人 员 更 快 地 理 解 现 有 的 代 码 库 ， 还 能 有 助 于 审 查 人 员 更 好 地 完 成 他 们 的 工 作 。 此 外 ， 单 元 测 试 能 让 审 查 人 员 更 好 地 理 解 各 个 组 件 的 使 用 。 如 果 在 你 的 补 丁 中 还 包 含 了 第 三 方 代 码 ， 那 么 单 独 提 交 。 试 想 一 下 ， 要 是 代 码 中 间 插 进 去 9 0 0 0 行 j Q u e r y ， 是 不 是 大 大 增 加 了 审 查 的 难 度 ！
创 建 可 审 查 代 码 最 重 要 的 步 骤 之 一 就 是 给 你 的 代 码 审 查 做 注 释 。 这 需 要 你 自 己 预 先 审 查 过 ， 然 后 在 你 认 为 有 助 于 审 查 人 员 理 解 的 地 方 添 加 注 释 。 我 发 现 ， 注 释 后 的 代 码 审 查 所 需 的 时 间 相 对 较 短 （ 通 常 只 需 几 分 钟 ） 。 当 然 ， 代 码 注 释 还 是 应 该 酌 情 使 用 。 此 外 ， 有 研 究 表 明 ， 开 发 人 员 自 己 在 给 代 码 注 释 的 时 候 也 会 发 现 许 多 存 在 的 缺 陷 。 代 码 重 构 有 时 候 ， 我 们 必 须 重 构 代 码 库 。 如 果 恰 巧 碰 到 的 是 一 个 大 型 的 应 用 程 序 ， 那 可 能 就 会 需 要 几 天 的 时 间 （ 甚 至 更 多 ） ， 同 时 会 产 生 大 量 的 补 丁 。 在 这 种 情 况 下 ， 想 要 做 到 标 准 流 程 的 代 码 评 审 可 能 是 不 切 实 际 的 。 最 好 的 解 决 办 法 是 逐 步 重 构 代 码 。 先 给 定 一 个 合 理 范 围 ， 确 定 相 应 的 代 码 库 ， 然 后 朝 着 目 标 方 向 做 整 改 和 重 构 。 第 一 部 分 完 成 之 后 ， 审 查 并 发 布 ， 然 后 进 行 第 二 部 分 的 重 构 … … ， 直 到 全 部 完 成 。 这 种 阶 段 式 的 方 法 可 能 并 不 总 是 可 行 的 ， 但 是 如 果 我 们 在 思 考 和 规 划 时 使 用 这 样 的 方 法 ， 可 以 避 免 重 构 时 大 规 模 的 单 片 补 丁 。 当 然 这 种 方 式 可 能 需 要 的 重 构 时 间 更 多 ， 但 是 也 会 产 出 更 高 质 量 的 代 码 ， 以 及 更 加 轻 松 的 审 查 过 程 。 如 果 增 量 重 构 代 码 还 是 不 可 行 ， 那 么 还 有 一 个 解 决 办 法 就 是 结 对 编 程 。 r e v i e w - 5 - t i p s - 0 3 解 决 争 端 毫 无 疑 问 ， 团 队 中 的 每 个 成 员 都 是 人 才 ， 但 是 这 也 很 容 易 导 致 在 面 对 特 定 的 编 码 问 题 时 ， 会 出 现 意 见 分 歧 的 情 况 。 作 为 开 发 人 员 ， 我 们 应 该 保 持 开 放 的 态 度 ， 并 且 也 要 能 虚 心 接 受 审 查 人 员 给 出 的 不 同 意 见 。 而 作 为 审 查 人 员 ， 说 话 要 委 婉 。 在 提 建 议 之 前 ， 先 考 虑 一 下 你 的 意 见 是 否 真 的 更 好 或 者 仅 仅 只 是 因 为 品 味 不 同 而 已 。 如 果 你 选 择 的 代 码 区 域 确 实 需 要 改 进 的 ， 那 么 整 个 说 服 过 程 就 会 简 单 得 多 。 并 且 话 要 这 样 讲 ， “ 这 里 还 值 得 考 虑 一 下 … … ” ， “ 有 人 建 议 说 … … ” ， 而 不 是 “ 我 闭 着 眼 睛 写 的 算 法 也 能 比 你 的 高 效 。 ” 当 然 如 果 你 们 双 方 都 不 肯 妥 协 的 话 ， 可 以 要 求 你 们 都 尊 重 的 开 发 人 员 来 看 一 看 ， 给 出 他 的 意 见 。
阅 读 原 文
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理