搜索

[23404] 2014-12-22_为什么你的代码如此难以理解

文档创建者：s7ckTeam
浏览次数：3
最后更新：2025-01-18
2014-12-22_为什么你的代码如此难以理解 为 什 么 你 的 代 码 如 此 难 以 理 解 L i n u x 中 国   2 0 1 4 - 1 2 - 2 2 “ 我 到 底 在 想 什 么 ？ ！ ？ ” 凌 晨 1 : 3 0 分 ， 我 正 盯 着 不 到 一 个 月 前 我 写 的 一 段 代 码 。 当 时 它 看 起 来 像 是 件 艺 术 品 ， 全 部 是 可 理 解 的 ， 优 雅 、 简 单 、 让 人 叹 为 观 止 。 这 一 切 都 不 再 了 ， 明 天 是 我 的 最 后 期 限 ， 数 小 时 前 我 发 现 了 一 个 b u g 。 当 时 看 起 来 的 简 单 和 逻 辑 再 也 说 不 通 了 。 可 以 肯 定 的 是 ， 如 果 是 我 写 的 代 码 ， 我 应 该 足 以 聪 明 到 理 解 代 码 ？ 经 过 了 多 次 这 种 经 历 以 后 ， 我 开 始 认 真 思 考 ， 为 什 么 我 的 代 码 在 我 编 写 的 时 候 很 清 楚 、 而 当 我 数 周 或 数 月 后 回 头 看 的 时 候 ， 它 们 却 那 么 费 解 。 问 题 1 ， 过 度 复 杂 的 心 智 模 型 为 了 理 解 当 你 间 隔 一 段 时 间 返 回 到 你 的 代 码 、 却 发 现 代 码 难 以 理 解 的 第 一 步 ， 就 是 理 解 我 们 如 何 从 心 智 上 建 立 问 题 模 型 。 你 写 的 几 乎 所 有 代 码 都 是 尽 量 解 决 现 实 世 界 的 问 题 。 在 你 写 代 码 之 前 ， 你 需 要 理 解 你 正 试 图 解 决 的 问 题 。 这 常 常 是 编 程 里 最 难 的 一 步 。 为 了 解 决 现 实 世 界 的 问 题 ， 我 们 首 先 需 要 形 成 该 问 题 的 心 智 模 型 【 注 1 】 ， 以 此 作 为 编 程 意 图 。 接 下 来 你 需 要 形 成 实 现 编 程 意 图 的 方 案 模 型 ， 我 们 姑 且 称 为 语 义 模 型 （ s e m a n t i c   m o d e l ） 。 从 来 不 要 混 淆 你 的 编 程 意 图 和 此 意 图 的 方 案 。 我 们 倾 向 于 主 要 考 虑 方 案 方 面 的 东 东 ， 而 常 常 忽 略 意 图 的 模 型 。 你 接 下 来 的 步 骤 是 形 成 可 能 最 简 单 的 语 义 模 型 。 这 是 容 易 搞 错 的 第 二 步 。 如 果 你 不 花 时 间 去 真 正 理 解 你 正 试 图 解 决 的 问 题 ， 你 将 在 写 代 码 时 被 绊 倒 在 模 型 上 。 另 一 方 面 ， 如 果 你 真 正 考 虑 了 你 正 尽 量 做 的 事 情 ， 你 经 常 得 到 一 个 非 常 简 单 的 模 型 ， 这 足 以 让 你 掌 握 最 初 的 意 图 。 如 果 你 想 容 易 地 维 护 简 单 的 代 码 ， 就 尽 可 能 多 些 地 消 除 意 外 的 复 杂 性 。 我 们 正 试 图 解 决 的 问 题 是 足 够 复 杂 的 。 如 果 你 不 必 那 么 做 ， 就 不 要 把
意 外 的 复 杂 性 增 加 进 来 。 问 题 2 ， 语 义 模 型 到 代 码 的 糟 糕 转 化 一 旦 你 尽 全 力 形 成 了 最 好 的 语 义 模 型 ， 那 么 就 到 了 把 它 转 化 为 代 码 的 时 候 了 。 我 们 称 之 为 句 法 模 型 （ s y n t a c t i c   m o d e l ） 。 你 正 试 图 把 你 的 语 义 模 型 的 意 义 转 化 为 计 算 机 能 够 理 解 的 句 法 。 如 果 你 有 非 常 不 错 的 语 义 模 型 、 而 在 转 化 为 代 码 时 搞 砸 了 ， 那 么 在 你 需 要 在 以 后 某 个 阶 段 回 头 修 改 代 码 时 ， 你 将 比 较 痛 苦 。 当 你 脑 子 里 还 有 语 义 模 型 时 ， 把 你 代 码 映 射 到 语 义 模 型 是 容 易 的 。 回 忆 起 变 量 “ x ” 实 际 上 代 表 一 条 记 录 被 创 建 的 日 期 、 而 “ y ” 代 码 记 录 被 删 除 的 日 期 ， 这 是 不 难 的 。 当 你 3 个 月 后 再 回 来 看 代 码 ， 你 的 脑 子 里 将 没 有 这 个 语 义 模 型 了 ， 因 此 无 法 理 解 同 样 的 变 量 名 字 。 把 语 义 模 型 转 化 为 句 法 的 任 务 就 是 尽 量 多 地 留 下 线 索 ， 让 你 在 今 后 返 回 时 ， 能 够 重 建 当 初 的 语 义 模 型 。 好 了 ， 你 该 怎 么 做 呢 ？ 类 结 构 和 命 名 如 果 你 在 使 用 面 向 对 象 语 义 ， 请 尽 量 让 你 的 类 结 构 和 命 名 靠 近 语 义 模 型 。 领 域 驱 动 设 计 （ D o m a i n   D r i v e n   D e s i g n ） 【 注 2 】 是 在 这 种 练 习 上 投 入 了 相 当 重 要 性 的 一 种 运 动 。 即 使 你 没 有 相 信 完 全 的 D D D 方 法 ， 你 也 应 当 非 常 小 心 地 考 虑 类 结 构 和 命 名 。 每 个 类 都 是 你 留 给 自 己 和 其 他 人 的 线 索 ， 它 帮 助 你 在 将 来 返 回 的 时 候 重 建 你 的 心 智 模 型 。 变 量 、 参 数 和 方 法 命 名 尽 量 避 免 普 通 的 变 量 和 方 法 命 名 。 不 要 把 方 法 命 名 为 “ P r o c e s s ” ， 因 为 “ P a y S a l e s C o m m i s i o n ” 更 有 意 义 。 不 要 把 变 量 命 名 为 “ x ” ， 因 为 它 应 当 是 “ c u r r e n t C o n t r a c t ” 。 不 要 把 参 数 命 名 为 “ i n p u t ” ， 因 为 “ o u t s t a n d i n g I n v o i c e s “ 更 好 。 单 一 功 能 原 则 （ S i n g l e   r e s p o n s i b i l i t y   p r i n c i p l e ， 简 称 S R P ） S R P 【 注 3 】 是 面 对 对 象 设 计 原 则 的 核 心 之 一 ， 关 联 着 好 的 类 和 变 量 命 名 。 它 认 为 ， 任 何 类 或 方 法 都 应 该 完 成 一 个 单 一 的 功 能 ， 只 能 是 一 个 单 一 的 功 能 。 如 果 你 想 为 类 和 方 法 给 出 有 意 义 的 名 字 ， 那 么 它 们 需 要 有 一 个 唯 一 的 较 好 定 义 的 目 的 。 如 果 一 个 单 一 类 从 数 据 库 读 和 写 、 计 算 营 业 税 、 通 知 交 易 客 户 并 生 成 账 单 ， 那 么 你 就 可 能 无 法 给 出 合 适 的 名 字 。 我 常 常 停 留 在 重 构 类 上 ， 因 为 我 总 是 努 力 取 一 个 足 够 短 的 名 字 ， 以 描 述 它 做 的 每 个 功 能 。 为 了 更 多 地 讨 论 S R P 和 其 它 面 向 对 象 原 则 ， 可 以 参 考 我 的 博 文 《 面 向 对 象 设 计 》 。 适 当 的 注 释 如 果 因 为 某 种 原 因 ， 你 不 能 让 代 码 变 得 清 晰 ， 你 同 情 将 来 的 自 己 ， 需 要 不 得 不 做 些 事 情 ， 那 就 留 下 注 释 来 说 明 你 为 什 么 不 得 不 那 样 做 。 注 释 倾 向 于 快 速 地 变 得 陈 旧 ， 因 此 我 宁 愿 尽 可 能 让 代 码 自 描 述 ， 注 释 用 来 说 明 为 什 么 你 不 得 不 那 样 做 ， 而 不 是 它 如 何 做 。 问 题 3 ， 没 有 足 够 的 组 块 心 理 学 上 的 组 块 被 定 义 是 ， 把 信 息 组 块 定 位 为 单 一 的 实 体 。 那 么 这 该 如 何 应 用 到 编 程 上 呢 ？ 作 为 一 名 开 发 者 ， 在 你 积 累 经 验 时 ， 你 开 始 发 现 你 解 决 方 案 里 反 复 出 现 的 模 式 。 极 具 影 响 的 设 计 模 式 ： 《 可 重 用 的 面 向 对 象 软 件 》 是 第 一 本 整 理 和 解 释 一 些 模 式 的 书 。 尽 管 如 此 ， 组 块 不 仅 仅 用 在 设 计 模 式 和 面 向 对 象 。 在 函 数 式 编 程 （ F P ） 里 ， 存 在 大 量 的 著 名 标 准 函 数 具 备 这 同 样 的 目 的 。 算 法 是 组 块 的 另 一 种 形 式 （ 后 续 会 更 多 ） 。 当 你 合 理 地 使 用 组 块 （ 设 计 模 式 、 算 法 和 标 准 函 数 ） 时 ， 它 让 你 停 下 来 思 考 ， 你 编 写 的 代 码 是 如 何 运 行 的 、 而 不 是 考 虑 它 做 了 什 么 。 这 缩 短 了 你 的 语 义 模 型 （ 你 的 代 码 ） 和 句 法 模 型 （ 你 脑 子 里 的 模 型 ） 的 距 离 。 这 个 距 离 越 短 ， 你 就 越 容 易 重 建 你 的 心 智 模 型 。 如 果 你 有 兴 趣 了 解 更 多 F P 里 的 函 数 ， 请 移 步 到 我 的 文 章 面 向 w e b 开 发 者 的 函 数 式 编 程 。 问 题 4 ， 费 解 的 用 法
原 文 ：   h t t p s : / / m e d i u m . c o m / o n - c o d i n g / w h y - y o u r - c o d e - i s - s o - h a r d - t o - u n d e r s t a n d - 8 3 0 5 7 c 1 1 5 a 2 b 译 文 ：   h t t p : / / w w w . l a b a z h o u . n e t / 2 0 1 4 / 1 1 / w h y - y o u r - c o d e - i s - s o - h a r d - t o - u n d e r s t a n d / # c o m m e n t s 目 前 ， 我 们 主 要 讨 论 了 如 何 结 构 化 你 的 类 、 方 法 和 变 量 命 名 。 心 智 模 型 的 另 一 个 重 要 部 分 是 理 解 这 些 方 法 应 该 怎 样 被 使 用 。 再 次 强 调 ， 当 你 最 初 形 成 心 智 模 型 时 ， 这 是 相 当 清 晰 的 。 当 你 后 来 返 回 时 ， 就 非 常 难 以 重 建 你 的 类 和 方 法 的 、 所 有 有 意 图 的 用 法 了 。 通 常 这 是 因 为 不 同 的 用 法 散 布 在 你 的 程 序 其 它 地 方 。 有 时 候 甚 至 出 现 在 很 多 不 同 的 项 目 中 。 我 就 是 在 这 种 情 况 下 发 现 测 试 用 例 是 非 常 有 用 的 。 除 了 相 应 地 知 道 一 个 修 改 是 否 破 坏 了 代 码 的 明 显 好 处 ， 测 试 为 你 的 代 码 提 供 了 一 整 套 的 用 例 。 你 不 必 搜 遍 1 0 0 个 文 件 ， 只 需 看 测 试 就 能 得 到 引 用 的 全 景 。 注 意 为 了 达 到 这 个 目 的 ， 你 需 要 有 一 整 套 完 整 的 测 试 用 例 。 如 果 你 的 测 试 仅 仅 覆 盖 了 一 部 分 、 而 你 认 为 测 试 是 完 整 的 ， 那 么 你 后 来 将 陷 入 困 境 。 问 题 5 ， 不 同 的 模 型 之 间 没 有 清 晰 的 途 径 你 的 代 码 从 技 术 角 度 看 ， 常 常 是 优 秀 的 、 非 常 优 雅 ， 但 是 从 程 序 意 图 到 语 义 模 型 、 再 到 代 码 存 在 非 常 不 自 然 的 跳 跃 。 考 虑 你 选 择 的 一 堆 模 型 的 透 明 性 是 重 要 的 。 从 程 序 意 图 到 语 义 模 型 、 再 到 代 码 的 过 程 需 要 尽 可 能 平 滑 。 你 应 当 能 够 看 透 对 应 到 问 题 的 每 个 模 型 的 所 有 方 面 。 多 数 情 况 下 ， 最 好 选 择 特 定 类 结 构 或 算 法 不 是 为 了 它 在 隔 离 方 面 的 优 雅 ， 而 是 可 以 连 接 各 种 模 型 ， 为 你 重 建 的 目 的 而 留 下   一 条 自 然 的 途 径 。 当 你 从 抽 象 的 编 程 意 图 走 到 具 体 的 代 码 时 ， 你 做 的 选 择 应 该 受 到   你 能 够 表 现 更 为 抽 象 模 型   的 清 晰 度 驱 使 。 问 题 6 ， 发 明 算 法 作 为 程 序 员 ， 我 们 经 常 认 为 ， 我 们 在 为 了 解 决 问 题 而 发 明 着 算 法 。 事 实 很 难 是 这 样 的 。 几 乎 所 有 情 况 下 ， 已 经 有 现 成 的 算 法 可 以 被 组 合 在 一 起 解 决 你 的 问 题 了 。 像 最 短 路 径 搜 索 法 、 字 符 串 相 似 度 算 法 、 粒 子 群 算 法 等 。 大 部 分 编 程 是 以 正 确 的 组 合 、 选 择 现 存 算 法 来 解 决 你 的 问 题 。 如 果 你 正 在 发 明 新 算 法 ， 那 么 ， 要 么 你 不 知 道 合 适 的 算 法 、 要 么 你 正 忙 于 你 的 博 士 论 文 。 总 结 最 后 总 结 ： 作 为 一 名 程 序 员 ， 你 的 目 标 是 建 立 能 够 解 决 你 问 题 的 、 尽 可 能 简 单 的 语 义 模 型 。 把 语 义 模 型 尽 可 能 靠 近 地 转 化 为 句 法 模 型 （ 代 码 ） ， 尽 可 能 多 地 提 供 线 索 ， 便 于 你 之 后 无 论 哪 个 人 看 你 的 代 码 ， 都 能 重 建 像 你 最 初 脑 子 里 的 、 相 同 的 语 义 模 型 。 设 想 一 下 ， 当 你 走 过 你 代 码 的 被 照 亮 的 森 林 时 ， 你 在 身 后 留 了 面 包 屑 。 相 信 我 ， 当 你 需 要 找 到 回 去 的 路 时 ， 森 林 将 充 满 了 黑 暗 、 朦 胧 和 不 详 的 预 感 。 听 起 来 容 易 ， 实 际 做 起 来 是 很 难 的 。 注 1 ： 心 智 模 型 是 用 于 解 释 个 体 为 现 实 世 界 中 之 某 事 所 运 作 的 内 在 认 知 历 程 。 h t t p : / / z h . w i k i p e d i a . o r g / w i k i / 心 智 模 型 注 2 ： 要 通 过 创 建 领 域 模 型 来 加 速 复 杂 的 软 件 开 发 ， 就 需 要 利 用 大 量 最 佳 实 践 和 标 准 模 式 在 开 发 团 队 中 形 成 统 一 的 交 流 语 言 ； 不 仅 重 构 代 码 ， 而 且 要 重 构 代 码 底 层 的 模 型 ； 同 时 采 取 反 复 迭 代 的 敏 捷 开 发 方 法 ， 深 入 理 解 领 域 特 点 ， 促 进 领 域 专 家 与 程 序 员 的 良 好 沟 通 。 h t t p : / / b a i k e . b a i d u . c o m / v i e w / 3 7 0 5 3 3 1 . h t m 注 3 ： 马 丁 把 功 能 （ 职 责 ） 定 义 为 ： “ 改 变 的 原 因 ” ， 并 且 总 结 出 一 个 类 或 者 模 块 应 该 有 且 只 有 一 个 改 变 的 原 因 。 一 个 具 体 的 例 子 就 是 ， 想 象 有 一 个 用 于 编 辑 和 打 印 报 表 的 模 块 。 这 样 的 一 个 模 块 存 在 两 个 改 变 的 原 因 。 第 一 ， 报 表 的 内 容 可 以 改 变 （ 编 辑 ） 。 第 二 ， 报 表 的 格 式 可 以 改 变 （ 打 印 ） 。 这 两 方 面 会 的 改 变 因 为 完 全 不 同 的 起 因 而 发 生 ： 一 个 是 本 质 的 修 改 ， 一 个 是 表 面 的 修 改 。 单 一 功 能 原 则 认 为 这 两 方 面 的 问 题 事 实 上 是 两 个 分 离 的 功 能 ， 因 此 他 们 应 该 分 离 在 不 同 的 类 或 者 模 块 里 。 把 有 不 同 的 改 变 原 因 的 事 物 耦 合 在 一 起 的 设 计 是 糟 糕 的 。 h t t p : / / z h . w i k i p e d i a . o r g / w i k i / 单 一 功 能 原 则
回复

举报

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

本版积分规则

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

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