搜索

[23363] 2014-12-09_同行代码审查（PeerCodeReview）实战经验

文档创建者：s7ckTeam
浏览次数：3
最后更新：2025-01-18
2014-12-09_同行代码审查（PeerCodeReview）实战经验 同 行 代 码 审 查 （ P e e r   C o d e   R e v i e w ） 实 战 经 验 L i n u x 中 国   2 0 1 4 - 1 2 - 0 9 我 有 时 候 会 听 到 我 们 的 团 队 成 员 这 样 议 论 ： " 项 目 的 C o d e   r e v i e w   只 是 浪 费 时 间 。 " " 我 没 有 时 间 做 C o d e   r e v i e w 。 " " 我 的 发 布 时 间 延 迟 了 ， 因 为 我 的 同 事 还 没 有 完 成 我 代 码 的 C o d e   r e v i e w 。 " " 你 相 信 我 的 同 事 居 然 要 求 我 对 我 的 代 码 做 修 改 吗 ？ 请 跟 他 们 说 代 码 中 的 一 些 联 系 会 被 打 断 — — 如 果 在 我 原 来 代 码 的 基 础 之 上 做 修 改 的 话 。 " ( L C T T   译 注 ： C o d e   R e v i e w 中 文 可 以 翻 译 成 代 码 审 查 , 一 般 由 开 发 待 r e v i e w 的 代 码 的 成 员 以 外 的 团 队 成 员 来 进 行 这 样 的 工 作 。 由 于 是 专 业 术 语 ， 没 有 将 C o d e   r e v i e w 用 中 文 代 替 。 ) 为 什 么 要 做 C o d e   r e v i e w ？ 每 个 专 业 软 件 开 发 者 都 有 一 个 重 要 的 目 标 ： 持 续 的 提 高 他 们 的 工 作 质 量 。 即 使 你 团 队 中 都 是 一 些 优 秀 的 程 序 员 ， 但 是 你 依 然 不 能 将 你 自 己 与 一 个 有 能 力 的 自 由 职 业 者 区 分 开 来 ， 除 非 你 从 团 队 的 角 度 来 工 作 。 C o d e   r e v i e w 是 团 队 工 作 的 一 个 重 要 的 方 面 。 尤 其 是 ： 代 码 复 查 者 ( r e v i e w e r ) 能 从 他 们 的 角 度 来 发 现 问 题 并 且 提 出 更 好 的 解 决 方 案 。 确 保 至 少 你 团 队 的 另 一 个 其 他 成 员 熟 悉 你 的 代 码 ， 通 过 给 新 员 工 看 有 经 验 的 开 发 者 的 代 码 能 够 某 种 程 度 上 提 高 他 们 的 水 平 。 公 开 r e v i e w e r 和 被 复 查 者 的 想 法 和 经 验 能 够 促 进 团 队 间 的 知 识 的 分 享 。 能 够 鼓 励 开 发 者 将 他 们 的 工 作 进 行 的 更 彻 底 ， 因 为 他 们 知 道 他 们 的 代 码 将 被 其 他 的 人 阅 读 。 在 r e v i e w 的 过 程 中 的 注 意 点 但 是 ， 由 于 C o d e   r e v i e w 的 时 间 有 限 ， 上 面 所 说 的 目 标 未 必 能 全 部 达 到 。 就 算 只 是 想 要 打 一 个 补 丁 ， 都 要 确 保 意 图 是 正 确 的 。 如 果 只 是 将 变 量 名 改 成 骆 驼 拼 写 法 ( c a m e l C a s e ) ， 那 不 算 是 c o d e   r e v i e w 。 在 开 发 过 程 中 进 行 结 对 编 程 是 有 益 处 的 ， 它 能 够 使 两 个 人 得 到 公 平 的 锻 炼 。 你 能 够 在
c o d e   r e v i e w 上 花 许 多 时 间 ， 并 且 仍 然 能 够 比 在 结 对 编 程 中 使 用 更 少 的 时 间 。 我 的 感 受 是 ， 在 项 目 开 发 的 过 程 中 ， 2 5 % 的 时 间 应 该 花 费 在 c o d e   r e v i e w 上 。 也 就 是 说 ， 如 果 开 发 者 用 两 天 的 时 间 来 开 发 一 个 东 西 ， 那 么 复 查 者 应 该 使 用 至 少 四 个 小 时 来 审 查 。 当 然 ， 只 要 你 的 r e v i e w 结 果 准 确 的 话 ， 具 体 花 了 多 少 时 间 就 显 得 不 是 那 么 的 重 要 。 重 要 的 是 ， 你 能 够 理 解 你 看 的 那 些 代 码 。 这 里 的 理 解 并 不 是 指 你 看 懂 了 这 些 代 码 书 写 的 语 法 ， 而 是 你 要 知 道 这 段 代 码 在 整 个 庞 大 的 应 用 程 序 、 组 件 或 者 库 中 起 着 什 么 样 的 作 用 。 如 果 你 不 理 解 每 一 行 代 码 的 作 用 ， 那 么 换 句 话 说 ， 你 的 c o d e   r e v i e w 就 是 没 有 价 值 的 。 这 就 是 为 什 么 好 的 c o d e   r e v i e w 不 能 很 快 完 成 的 原 因 。 需 要 时 间 来 探 讨 各 种 各 样 的 代 码 路 径 ， 让 它 们 触 发 一 个 特 定 的 函 数 ， 来 确 保 第 三 方 的 A P I 得 到 了 正 确 的 使 用 ( 包 括 一 些 边 缘 测 试 ) 。 为 了 查 阅 你 所 审 查 的 代 码 的 缺 陷 或 者 是 其 他 问 题 ， 你 应 该 确 保 ： 所 有 必 要 的 测 试 都 已 经 被 包 含 进 去 。 合 理 的 设 计 文 档 已 经 被 编 写 。 再 熟 练 的 开 发 者 也 不 是 每 次 都 会 记 得 在 他 们 对 代 码 改 动 的 时 候 把 测 试 程 序 和 文 档 更 新 上 去 。 来 自 r e v i e w e r 的 一 个 提 醒 能 够 使 得 测 试 用 例 和 开 发 文 档 不 会 一 直 忘 了 更 新 。 避 免 c o d e   r e v i e w 负 担 太 大 如 果 你 的 团 队 没 有 强 制 性 的 c o d e   r e v i e w ， 当 你 的 c o d e   r e v i e w 记 录 停 留 在 无 法 管 理 的 节 点 上 时 会 很 危 险 。 如 果 你 已 经 两 周 没 有 进 行 c o d e   r e v i e w 了 ， 你 可 以 花 几 天 的 时 间 来 跟 上 项 目 的 进 度 。 这 意 味 着 你 自 己 的 开 发 工 作 会 被 阻 断 ， 当 你 想 要 处 理 之 前 遗 留 下 来 的 c o d e   r e v i e w 的 时 候 。 这 也 会 使 得 你 很 难 再 确 保 c o d e   r e v i e w 的 质 量 ， 因 为 合 理 的 c o d e   r e v i e w 需 要 长 期 认 真 的 努 力 ， 最 终 会 很 难 持 续 几 天 都 保 持 这 样 的 状 态 。 由 于 这 个 原 因 ， 开 发 者 应 当 每 天 都 完 成 他 们 的 r e v i e w 任 务 。 一 种 好 办 法 就 是 将 c o d e   r e v i e w 作 为 你 每 天 的 第 一 件 事 。 在 你 开 始 自 己 的 开 发 工 作 之 前 完 成 所 有 的 c o d e   r e v i e w 工 作 ， 能 够 使 你 从 头 到 尾 都 集 中 注 意 力 。 有 些 人 可 能 更 喜 欢 在 午 休 前 或 午 休 后 或 者 在 傍 晚 下 班 前 做 r e v i e w 。 无 论 你 在 哪 个 时 间 做 ， 都 要 将 c o d e   r e v i e w 看 作 你 的 工 作 之 一 并 且 不 能 分 心 ， 你 要 避 免 ： 没 有 足 够 的 时 间 来 处 理 你 的 r e v i e w 任 务 。 由 于 你 的 c o d e   r e v i e w 工 作 没 有 做 完 导 致 版 本 的 推 迟 发 布 。 提 交 不 再 相 关 的 r e v i e w ， 由 于 代 码 在 你 r e v i e w 期 间 已 经 改 动 太 大 。 因 为 你 要 在 最 后 一 分 钟 完 成 他 们 ， 以 至 于 r e v i e w 质 量 太 差 。 书 写 易 于 r e v i e w 的 代 码 有 时 候 r e v i e w 没 有 按 时 完 成 并 不 都 是 因 为 r e v i e w e r 。 如 果 我 的 同 事 使 用 一 周 时 间 在 一 个 大 工 程 中 添 加 了 一 些 乱 七 八 糟 的 代 码 ， 且 他 们 提 交 的 补 丁 实 在 是 太 难 以 阅 读 。 在 一 段 代 码 中 有 太 多 的 东 西 要 浏 览 。 这 样 会 让 人 难 以 理 解 它 的 作 用 ， 自 然 会 拖 慢 r e v i e w 的 进 度 。 为 什 么 将 你 的 工 作 划 分 成 一 些 易 于 管 理 的 片 段 很 重 要 有 很 多 原 因 。 我 们 使 用 s c r u m 方 法 论 ( 一 种 软 件 开 发 过 程 方 法 ) ， 因 此 对 我 们 来 说 一 个 合 理 的 单 元 就 是 一 个 s t o r y 。 通 过 努 力 将 我 们 的 工 作 使 用 s t o r y 组 织 起 来 ， 并 且 只 是 将 r e v i e w 提 交 到 我 们 正 在 工 作 的 s t o r y 上 ， 这 样 ， 我 们 写 的 代 码 就 会 更 加 易 于 r e v i e w 。 你 们 也 可 以 使 用 其 他 的 软 件 开 发 方 法 ， 但 是 目 的 是 一 样 的 。 书 写 易 于 r e v i e w 的 代 码 还 有 其 他 先 决 条 件 。 如 果 要 做 一 些 复 杂 的 架 构 决 策 ， 应 该 让 r e v i e w e r 事 先 知 道 并 参 与 讨 论 。 这 会 让 他 们 之 后 r e v i e w 你 们 的 代 码 更 加 容 易 ， 因 为 他 们 知 道 你 们 正 在 试 图 实 现 什 么 功 能 并 且 知 道 你 们 打 算 如 何 来 实 现 。 这 也 避 免 了 开 发 者 需 要 在 r e v i e w e r 提 了 一 个 不 同 的 或 者 更 好 的 解 决 方 案 后 大 片 的 重 写 代 码 。 项 目 需 要 应 当 在 设 计 文 档 中 详 细 的 描 述 。 这 对 于 一 个 项 目 新 成 员 想 要 快 速 上 手 并 且 理 解 现 有 的 代 码 来 说 非 常 重 要 。 这 从 长 远 角 度 对 于 一 个 r e v i e w e r 来 说 也 非 常 有 好 处 。 单 元 测 试 也 有 助 于 r e v i e w e r 知 道 一 些 组 件 是 怎 么 使 用 的 。
如 果 你 在 你 的 补 丁 中 包 含 的 第 三 方 的 代 码 ， 记 得 单 独 的 提 交 它 。 当 j Q u e r y 的 9 0 0 0 行 代 码 被 插 入 到 了 项 目 代 码 的 中 间 ， 毫 无 疑 问 会 造 成 难 以 阅 读 。 创 建 易 读 的 r e v i e w 代 码 的 另 一 个 非 常 重 要 的 措 施 是 添 加 相 应 的 注 释 代 码 。 这 就 要 求 你 事 先 自 己 做 一 下 r e v i e w 并 且 在 一 些 你 认 为 会 帮 助 r e v i e w e r 进 行 r e v i e w 的 地 方 加 上 相 应 的 注 释 。 我 发 现 加 上 注 释 相 对 于 你 来 说 往 往 只 需 要 很 短 的 时 间 ( 通 常 是 几 分 钟 ) ， 但 是 对 于 r e v i e w 来 说 会 节 约 很 多 的 时 间 。 当 然 ， 代 码 注 释 还 有 其 他 相 似 的 好 处 ， 应 该 在 合 理 的 地 方 使 用 ， 但 往 往 对 c o d e   r e v i e w 来 说 更 重 要 。 事 实 上 ， 有 研 究 表 明 ， 开 发 者 在 重 读 并 注 释 他 们 代 码 的 过 程 中 ， 通 常 会 发 现 很 多 问 题 。 代 码 大 范 围 重 构 的 情 况 有 时 候 ， 有 必 要 重 构 一 段 代 码 使 其 能 够 作 用 于 多 个 其 他 组 件 。 若 是 一 个 大 型 的 应 用 要 这 样 做 ， 会 花 费 几 天 甚 至 是 更 多 的 时 间 ， 结 果 是 生 成 一 个 诺 大 的 补 丁 包 。 在 这 种 情 况 下 ， 进 行 一 个 标 准 的 c o d e   r e v i e w 可 能 是 不 切 实 际 的 。 最 好 的 方 法 是 增 量 重 构 你 的 代 码 。 找 出 合 理 范 围 内 的 一 部 分 改 变 ， 以 此 为 基 础 来 重 构 。 一 旦 修 改 和 r e v i e w 完 成 ， 进 入 第 二 个 增 量 。 以 此 类 推 ， 直 到 整 个 重 构 完 成 。 这 种 方 法 可 能 不 是 在 所 有 的 情 况 下 都 可 行 ， 但 是 尽 管 如 此 ， 也 能 避 免 在 重 构 时 出 现 大 量 的 单 片 补 丁 。 开 发 者 使 用 这 种 方 式 重 构 可 能 会 花 去 更 多 的 时 间 ， 但 这 也 使 得 代 码 质 量 更 高 并 且 之 后 的 r e v i e w 会 更 简 单 。 如 果 实 在 是 没 有 条 件 去 通 过 增 量 方 式 重 构 代 码 ( 有 人 可 能 会 说 之 前 的 代 码 书 写 并 组 织 的 是 多 么 的 好 ) ， 一 种 解 决 方 案 是 在 重 构 时 进 行 结 对 编 程 来 代 替 c o d e   r e v i e w 。 解 决 团 队 成 员 之 间 的 纠 纷 你 的 团 队 中 都 是 一 些 有 能 力 的 专 家 ， 在 一 些 案 例 中 ， 完 全 有 可 能 因 为 对 一 个 具 体 编 码 问 题 的 意 见 的 不 同 而 产 生 争 论 。 作 为 一 个 开 发 者 ， 应 该 保 持 一 个 开 发 的 头 脑 并 且 时 刻 准 备 着 妥 协 ， 当 你 的 r e v i e w e r 更 想 要 另 一 种 解 决 方 法 时 。 不 要 对 你 的 代 码 持 有 专 有 的 态 度 ， 也 不 要 自 己 持 有 审 查 的 意 见 。 因 为 有 人 会 觉 得 你 应 该 将 一 些 重 复 的 代 码 写 入 一 个 能 够 复 用 的 函 数 中 去 ， 这 并 不 意 味 着 这 是 你 的 问 题 。 作 为 一 个 r e v i e w e r ， 要 灵 活 。 在 提 出 修 改 建 议 之 前 ， 考 虑 你 的 建 议 是 否 真 的 更 好 或 者 只 是 无 关 紧 要 。 如 果 你 把 力 气 和 注 意 力 花 在 那 些 原 来 的 代 码 会 明 确 需 要 改 进 的 地 方 会 更 加 成 功 。 你 应 该 说 " 它 或 许 值 得 考 虑 . . . " 或 者 " 一 些 人 建 议 . . . " 而 不 是 ” 我 的 宠 物 都 能 写 一 个 比 这 个 更 加 有 效 的 排 序 方 法 " 。 如 果 你 真 的 决 定 不 了 ， 那 就 询 问 另 一 个 你 及 你 所 审 查 的 人 都 尊 敬 的 开 发 者 来 听 一 下 你 意 见 并 给 出 建 议 。 v i a :   h t t p : / / b l o g . s a l s i t a s o f t . c o m / p r a c t i c a l - l e s s o n s - i n - p e e r - c o d e - r e v i e w / 作 者 ： M a t t   译 者 ： j o h n   校 对 ： w x y 本 文 由   L C T T   原 创 翻 译 ， L i n u x 中 国   荣 誉 推 出
阅 读 原 文
回复

举报

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

本版积分规则

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

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