搜索

[22456] 2014-03-13_代码审查和不良编程习惯

文档创建者：s7ckTeam
浏览次数：9
最后更新：2025-01-18
2014-03-13_代码审查和不良编程习惯 代 码 审 查 和 不 良 编 程 习 惯 L i n u x 中 国   2 0 1 4 - 0 3 - 1 3 有 时 候 ， 做 为 一 个 程 序 员 ， 我 觉 得 我 的 职 业 生 涯 会 被 我 开 发 软 件 使 用 的 开 发 工 具 和 技 术 架 构 明 显 的 分 割 成 几 个 阶 段 。 一 部 分 是 因 为 使 用 的 编 程 语 言 — — 在 大 学 时 是 S m a l l t a l k ， 在 G o g   C r e e k 公 司 是 C # 和 P y t h o n ， 而 另 一 方 面 是 开 发 工 具 。 我 在 F o g   C r e e k 公 司 里 工 作 了 8 年 ， 在 那 里 ， 我 们 有 一 个 非 常 固 定 的 技 术 架 构 ： b u g 管 理 、 客 户 支 持 和 文 档 管 理 用 F o g B u g z ； 开 发 管 理 用 T r e l l o ； 代 码 审 查 用 K i l n ； 版 本 控 制 用 M e r c u r i a l ； 编 码 用 V i m 和   V i s u a l   S t u d i o   ； 持 续 集 成 用 我 们 的 内 部 工 具 M o r t a r ； 随 着 时 间 的 流 逝 ， 这 些 工 具 在 慢 慢 的 变 化 ， 但 变 化 从 来 都 是 缓 慢 逐 步 的 ， 一 个 组 件 一 个 组 件 的 。 所 以 ， 我 的 工 作 流 程 和 工 作 效 率 一 直 没 有 巨 大 的 变 化 。 大 概 一 个 月 前 ， 我 加 入 了 K n e w t o n 公 司 ， 整 个 技 术 架 构 一 下 子 完 全 变 了 。 V i s u a l   S t u d i o 换 成 了 I n t e l l i J ； M o r t a r 换 成 了 J e n k i n s ； M e r c u r i a l 换 成 了 G i t ； F o g B u g z 换 成 了 J I R A 。 也 许 你 会 觉 得 这 会 让 我 头 大 ， 还 会 有 些 不 知 所 措 ， 但 事 实 上 并 不 是 这 样 ， 这 些 工 具 的 改 变 并 没 有 对 我 的 工 作 流 程 产 生 多 大 的 影 响 。 我 发 现 G i t 和 M e r c u r i a l 惊 人 的 相 似 ， J I R A 基 本 上 是 一 个 半 成 品 的 F o g B u g z ， 而 I n t e l l i J 算 是 和 V i s u a l   S t u d i o 差 不 多 吧 。 也 许 我 需 要 从 新 学 习 一 些 快 捷 键 和 了 解 按 钮 的 位 置 ， 但 事 实 上 我 的 开 发 模 式 没 有 实 质 的 变 化 。 但 有 一 个 例 外 ： 我 不 喜 欢 使 用 G e r r i t 做 代 码 审 查 。 不 喜 欢 它 的 原 因 并 不 是 它 的 程 序 写 的 很 烂 ； 不 喜 欢 的 原 因 是 它 的 流 程 会 鼓 励 一 种 不 良 编 程 习 惯 。 K n e w t o n 公 司 对 代 码 审 查 非 常 、 非 常 的 看 重 。 这 非 常 好 ， 因 为 我 也 是 这 样 ， 而 且 我 开 发 过 整 套 关 于 代 码 审 查 的 工 具 。 所 以 ， 我 的 意 思 绝 对 不 是 反 对 代 码 审 查 。 而 且 ， G e r r i t 的 设 计 跟 最 初 的   K i l n   原 型 的 设 计 几 乎 完 全 一 致 。 代 码 审 查 的 实 施 有 两 种 基 本 的 方 式 ： p r e - m e r g e ， 是 指 在 代 码 进 入 主 代 码 库 之 前 进 行 代 码 审 查 。 和 p o s t - c o m m i t ， 是 指 之 后 审 查 。 新 版 本 的 K i l n 对 两 种 方 式 都 支 持 ， 但 在 2 0 0 8 年 ， 当 T y l e r 和 我 通 过 一 个 项 目 — — 也 就 是 K i l n 的 前 身 — — 在 D j a n g o   D a s h 中 取 胜 时 ， 我 们 俩 都 认 同 p r e - m e r g e 的 工 作 流 程 。 直 接 提 交 到 主 代 码 库 是 不 允 许 的 ； 你 需 要 先 创 建 一 个 审 查 区 ， 把 修 改 的 代 码 放 进 去 ， 讨 论 ， 然 后 ， 等 待 批 准 ， 系 统 会 自 动 合 并 这 些 代 码 。 这 一 种 是 我 最 欣 赏 的 工 作 流 程 ， 所 以 K i l n 一 直 支 持 这 种 方 式 ( 通 过 “ R e a d   a n d   B r a n c h ” 权 限 ) ， 而 巧 的 事 ， 这 也 是 G e r r i t 唯 一 支 持 的 方 式 ， 按 理 说 我 应 该 喜 欢 它 才 是 。 我 差 一 点 就 喜 欢 它 了 ， 但 问 题 出 在 一 个 致 命 问 题 上 ： 代 码 审 查 的 粒 度 。 代 码 审 查 的 粒 度 。 在 K i l n 中 ， 审 查 是 基 于 被 修 改 的 相 关 代 码 被 修 改 的 相 关 代 码 。 而 在 G e r r i t 里 ， 审 查 是 基 于 单 次 代 码 修 改 提 交 单 次 代 码 修 改 提 交 。 在 K i l n 中 ， 一 个 单 一 审 查 会 涉 及 很 多 次 代 码 提 交 ， 审 查 的 批 准 和 拒 绝 是 整 体 的 ， 而 G e r r i t 里 审 查 的 是 一 次 孤 立 的 提 交 。 这 两 种 方 法 模 式 在 各 自 的 阵 营 里 都 有 大 量 的 受 欢 迎 的 系 统 实 现 。 G i t H u b 和 B i t b u c k e t 都 和 K i l n 一 样 都 属 于 “ 批 量 提 交 ” 审 查 阵 营 ， 而 R e v i e w   B o a r d , B a r k e e p ,   和   P h a b r i c a t o r   都 加 入 了 “ 单 一 提 交 ” 审 查 阵 营 。 所 以 ， 情 况 并 不 是 我 所 说 的 某 一 种 方 式 、 某 一 款 软 件 是 对 的 ， 而 其 它 都 是 错 的 。 但 我
还 是 要 坚 持 说 ， 批 量 审 查 的 方 式 是 对 的 ， 而 其 余 的 都 是 错 的 ， 因 为 单 一 提 交 审 查 系 统 在 鼓 励 一 种 不 良 编 程 习 惯 。 单 一 提 交 审 查 系 统 在 鼓 励 一 种 不 良 编 程 习 惯 。 单 一 提 交 审 查 系 统 有 两 个 最 根 本 的 问 题 ： 1 .   它 在 向 你 暗 示 各 个 修 改 提 交 之 间 没 有 关 联 。 它 在 向 你 暗 示 各 个 修 改 提 交 之 间 没 有 关 联 。 经 常 的 ， 每 当 我 实 现 一 个 新 功 能 时 ， 我 都 会 有 三 个 步 骤 ： 首 先 ， 重 构 现 有 的 代 码 ， 让 代 码 整 洁 ， 方 便 添 加 新 功 能 ； 接 下 来 ， 加 入 新 功 能 ； 最 后 ， 写 单 元 测 试 代 码 。 功 能 越 复 杂 ， 各 个 步 骤 里 越 有 可 能 各 自 包 含 多 个 逻 辑 步 骤 。 如 果 能 将 多 个 不 同 的 提 交 放 的 一 个 代 码 审 查 中 进 行 ， 那 你 就 可 以 简 单 的 将 这 些 修 改 分 组 提 交 。 但 如 果 使 用 的 是 单 一 提 交 审 查 系 统 ， 那 就 是 在 迫 使 我 将 所 有 修 改 全 部 完 成 后 进 行 一 次 全 量 提 交 。 这 样 一 来 ， 重 构 的 代 码 ， 新 添 加 的 代 码 ， 都 混 在 一 起 ， 让 人 非 常 不 爽 ， 而 且 在 审 查 过 程 中 需 要 我 付 出 大 量 额 外 的 精 力 来 指 出 各 部 分 代 码 都 是 干 嘛 的 。 你 也 许 会 争 辩 ， 说 你 可 以 把 修 改 的 代 码 拆 分 提 交 ， 每 一 个 提 交 对 应 一 次 审 查 。 但 事 实 上 这 样 做 会 更 糟 。 最 好 的 情 况 下 ， 你 可 以 把 测 试 程 序 和 新 功 能 代 码 分 开 提 交 ， 可 以 把 重 构 代 码 和 后 加 代 码 分 开 提 交 ， 但 真 正 的 问 题 是 ， 众 多 的 单 一 修 改 审 查 系 统 都 怂 恿 对 某 个 提 交 在 孤 立 孤 立 的 状 态 下 进 行 批 准 ， 这 完 全 会 和 你 的 愿 望 相 反 相 反 。 于 是 ， “ 一 次 提 交 一 次 审 查 ” 的 折 中 就 从 “ 麻 烦 ” 变 成 了 “ 危 险 ” 。 的 确 不 是 一 种 改 进 。 2 .   它 在 怂 恿 你 隐 藏 历 史 记 录 它 在 怂 恿 你 隐 藏 历 史 记 录 。 版 本 控 制 系 统 的 最 重 要 的 功 能 就 是 告 诉 你 代 码 演 变 的 历 史 、 是 如 何 变 成 今 天 这 个 样 子 的 。 我 经 常 会 查 看 昨 天 代 码 是 什 么 样 的 ， 上 周 二 下 午 2 点 代 码 是 什 么 样 的 ， 期 间 发 生 了 什 么 变 化 。 很 多 时 候 是 因 为 我 发 现 代 码 以 前 好 用 而 现 在 不 行 ， 我 想 知 道 为 什 么 。 而 更 多 时 候 ， 我 是 想 知 道 为 什 么 会 对 代 码 做 这 样 的 修 改 。 关 联 的 上 下 文 是 什 么 ？ 动 机 是 什 么 ？ 如 果 你 总 是 保 持 所 有 代 码 一 次 提 交 — — 为 了 审 查 ， 那 我 就 丧 失 了 很 多 历 史 信 息 ： 所 有 我 能 找 到 的 就 是 一 次 完 整 软 件 的 一 次 提 交 ， 完 全 没 有 开 发 过 程 中 的 过 程 信 息 。 这 就 是 我 为 什 么 对 G e r r i t 极 度 失 望 的 原 因 。 并 不 是 G e r r i t 是 一 个 糟 糕 的 软 件 ， 而 是 他 在 鼓 励 一 种 在 使 用 版 本 控 制 时 不 良 的 开 发 习 惯 。 这 就 是 为 什 么 所 有 工 具 中 唯 独 不 喜 欢 它 的 原 因 ， 是 唯 一 让 我 对 放 弃 K i l n 感 到 失 望 的 系 统 。 [ 英 文 原 文 ： C o d e   r e v i e w s   a n d   b a d   h a b i t s   ] v i a :   h t t p : / / w w w . v a i k a n . c o m / c o d e - r e v i e w s - a n d - b a d - h a b i t s /   本 文 地 址 ： h t t p : / / l i n u x . c n / a r t i c l e - 2 6 6 8 - 1 . h t m l   阅 读 原 文
回复

举报

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

本版积分规则

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

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