搜索

[23816] 2015-04-21_史上最糟糕的两个变量名

文档创建者：s7ckTeam
浏览次数：3
最后更新：2025-01-18
2015-04-21_史上最糟糕的两个变量名 史 上 最 糟 糕 的 两 个 变 量 名 L i n u x 中 国   2 0 1 5 - 0 4 - 2 1 作 为 一 个 程 序 员 ， “ 起 名 字 ” 是 他 们 工 作 中 非 常 重 要 的 一 部 分 。 P h i l   K a r l t o n 就 说 过 ： “ 在 计 算 机 科 学 领 域 ， 有 两 大 难 题 ， 如 何 验 证 缓 存 和 如 何 给 各 种 东 西 命 名 。 ” 虽 然 很 难 ， 但 是 每 次 在 写 代 码 的 时 候 ， 给 事 物 起 名 字 又 是 不 可 回 避 的 工 作 。 无 论 是 程 序 变 量 名 还 是 数 据 库 表 名 或 者 是 表 里 的 列 名 ， 甚 至 是 文 件 系 统 中 的 文 件 名 ， 以 及 你 的 项 目 名 称 、 产 品 名 称 ， 给 这 些 东 西 起 名 字 可 不 是 个 轻 松 活 儿 。 糟 糕 的 命 名 方 式 随 处 可 见 。 你 会 发 现 ， 有 的 变 量 名 字 起 得 太 短 ， 根 本 没 法 提 供 足 够 的 描 述 信 息 。 或 许 有 这 个 问 题 的 人 都 做 过 T R S - 8 0   B A S I C 程 序 员 ， 在 这 种 B A S I C 语 言 里 ， 无 论 你 起 多 长 的 变 量 名 ， 只 有 名 字 的 头 两 个 字 母 有 效 ， 所 以 那 个 时 候 的 程 序 员 不 得 不 在 键 盘 边 儿 上 放 个 笔 记 本 ， 以 便 将 很 短 的 变 量 名 称 和 他 们 的 对 应 含 义 记 录 下 来 ， 这 样 才 能 不 搞 混 淆 。 有 的 时 候 ， 你 会 发 现 这 样 的 命 名 方 法 ： 直 接 将 变 量 名 称 中 的 原 音 字 母 省 略 ， 以 此 来 缩 短 变 量 的 长 度 。 这 种 方 法 被 用 来 替 代 常 用 的 “ 截 断 法 ” ， 也 就 是 简 单 地 把 字 母 截 断 来 缩 短 长 度 。 比 如 你 可 以 用 $ c s t m r ( 原 音 省 略 ) 来 代 替 $ c u s t ( 直 接 截 断 ) .   但 是 ， 对 于 c u s t o m e r s （ 顾 客 ） 和 c o s t u m e r s （ 服 装 提 供 商 ） 这 两 个 单 词 来 说 ， 原 音 省 略 法 就 会 造 成 混 淆 ( c u s t o m e r s 和 c o s t u m e r s 采 用 原 音 省 略 法 ， 其 结 果 都 是 c s t m r ) 。 更 糟 糕 的 是 ， $ c s t m r 缺 乏 原 音 字 母 ， 打 字 的 时 候 会 更 加 别 扭 ， 而 且 从 读 音 的 角 度 来 说 ， 也 很 难 对 其 进 行 发 音 。 还 有 一 种 人 为 的 特 殊 命 名 方 式 ， 有 的 时 候 程 序 的 作 者 只 是 为 了 小 幽 一 默 ， 所 以 起 了 些 有 趣 的 名 字 。 我 就 曾 经 见 到 过 有 人 把 循 环 变 量 命 名 为 $ c r a p   ( c r a p 在 英 语 里 是 轻 微 的 咒 骂 ， 跟 d a m m , s h i t 这 种 词 语 差 不 多 — — 译 者 注 ) ， 我 的 一 个 同 事 告 诉 我 ， 他 在 给 一 段 代 码 做 整 理 的 时 候 ， 看 到 过 有 个 函 数 被 命 名 为 : T H E _ L O N E _ R A N G E R _ R I D E S _ A G A I N ( ) 。 虽 然 这 样 的 命 名 方 式 非 常 特 殊 ， 但 是 他 们 并 不 属 于 我 说 的 “ 糟 糕 ” 的 命 名 的 范 畴 。 虽 然 我 很 清 楚 ， 对 于 命 名 规 范 这 种 事 情 ， 大 家 是 公 说 公 有 理 ， 婆 说 婆 有 理 ， 但 是 ， 我 还 是 非 常 自 信 地 宣 布 ， 我 认 为 ， 史 上 最 糟 糕 的 命 名 是 ： $ d a t a ! 是 的 ！ 必 须 是 $ d a t a !   这 个 命 名 完 全 是 循 环 定 义 ， 实 际 上 就 是 一 句 废 话 。 就 仿 佛 你 把 你 们 家 所 有 的 东 西 都 扔 到 一 个 行 李 箱 里 ， 然 后 在 行 李 箱 上 面 贴 个 条 ， 赫 然 写 着 ： “ 东 西 ”
正 确 变 量 命 名 应 该 写 清 楚 变 量 的 数 据 类 型 。 因 此 在 命 名 是 考 虑 数 据 类 型 是 一 个 很 好 的 提 升 命 名 质 量 的 办 法 。 我 有 一 次 在 看 一 段 读 数 据 库 表 记 录 的 代 码 时 ， 看 到 了 $ d a t a 这 个 名 字 ， 大 概 像 下 面 这 样 ： 模 糊 的 命 名 相 当 糟 糕 ， 糟 糕 程 度 紧 随 其 后 的 就 是 ， 长 得 几 乎 一 样 ， 无 法 分 辨 的 变 量 名 。 因 此 ， 有 史 以 来 第 二 糟 糕 的 变 量 名 就 是 :   $ d a t a 2 . 如 果 这 时 候 问 问 ： “ $ d a t a 是 什 么 数 据 类 型 呢 ？ ” , 然 后 你 就 很 想 给 它 换 个 名 字 了 。 把 名 字 改 成 $ r e c o r d 是 一 个 好 的 开 始 。 进 一 步 改 成 $ c u s t o r m e r _ r e c o r d ， 就 更 好 一 些 了 。 总 的 来 说 ， 任 何 仅 仅 依 靠 数 字 编 号 来 区 分 的 变 量 名 都 应 该 被 重 构 。 马 上 举 个 例 子 给 你 看 ， 你 就 明 白 了 ： 你 可 以 发 现 ， 要 读 懂 这 个 代 码 就 跟 读 甲 骨 文 一 样 痛 苦 。 很 明 显 ， 这 个 程 序 的 目 的 就 是 要 计 算 订 单 的 总 花 费 ， $ t o t a l .   如 果 程 序 的 逻 辑 没 有 问 题 ， 那 么 $ t o t a l 这 个 变 量 名 也 算 是 恰 如 其 分 。 但 是 ， 偏 偏 有 人 修 改 了 这 个 程 序 ， 给 添 加 了 计 算 折 扣 和 税 率 的 功 能 ， 然 后 他 还 在 变 量 命 名 上 偷 懒 ， 直 接 起 了 个 $ t o t a l 2 ,   更 可 恨 的 是 ， 还 有 其 他 人 在 这 个 程 序 里 计 算 了 用 户 的 可 用 账 户 金 额 ， 然 后 直 接 起 名 叫 $ t o t a l 3 ! 真 正 倒 霉 催 的 是 下 面 这 行 代 码 ： 如 果 你 看 到 了 类 似 像 $ t o t a l 2 这 样 的 变 量 ， 那 就 应 该 把 这 个 名 字 改 得 更 加 具 体 一 些 。 花 5 分 钟 的 时 间 让 这 些 变 量 名 称 变 得 更 加 合 理 。 这 个 层 面 上 的 软 件 重 构 是 最 简 单 ， 代 价 最 小 ， 也 是 最 安 全 的 ， 尤 其 是 在 你 要 修 改 的 变 量 是 个 局 部 变 量 的 时 候 。 如 果 你 不 回 头 看 之 前 的 代 码 ， 要 想 知 道 这 句 代 码 的 意 义 是 完 全 不 可 能 的 。 所 以 你 必 须 往 回 阅 读 ， 看 看 哪 个 变 量 究 竟 是 什 么 意 思 。 让 我 们 用 最 简 单 的 “ 搜 索 - 替 换 ” 功 能 来 解 决 我 们 之 前 发 现 的 问 题 1 .   $ d a t a   =   r e a d _ r e c o r d ( ) ; 2 .   p r i n t   " I D   =   " ,   $ d a t a [ " C U S T O M E R _ I D " ] ; 1 .   $ t o t a l   =   $ p r i c e   *   $ q t y ; 2 .   $ t o t a l 2   =   $ t o t a l   -   $ d i s c o u n t ; 3 .   $ t o t a l 2   + =   $ t o t a l 2   *   $ t a x r a t e ; 4 .   $ t o t a l 3   =   $ p u r c h a s e _ o r d e r _ v a l u e   +   $ a v a i l a b l e _ c r e d i t ; 5 .   i f   (   $ t o t a l 2   <   $ t o t a l 3   )   { 6 .           p r i n t   " Y o u   c a n ' t   a f f o r d   t h i s   o r d e r . " ; 7 .   } 1 .   i f   (   $ t o t a l 2   <   $ t o t a l 3   ) 1 .   $ o r d e r _ t o t a l   =   $ p r i c e   *   $ q t y ;   2 .   $ p a y a b l e _ t o t a l   =   $ o r d e r _ t o t a l   -   $ d i s c o u n t ; 3 .   $ p a y a b l e _ t o t a l   + =   $ p a y a b l e _ t o t a l   *   $ t a x r a t e ; 4 .   $ a v a i l a b l e _ f u n d s   =   $ p u r c h a s e _ o r d e r _ v a l u e   +   $ a v a i l a b l e _ c r e d i t ; 5 .   i f   (   $ p a y a b l e _ t o t a l   <   $ a v a i l a b l e _ f u n d s   )   { 6 .           p r i n t   " Y o u   c a n ' t   a f f o r d   t h i s   o r d e r . " ; 7 .   }
原 文 ： h t t p : / / p e t d a n c e . c o m / 2 0 1 2 / 0 4 / t h e - w o r l d s - t w o - w o r s t - v a r i a b l e - n a m e s / 译 文 ： h t t p : / / b l o g . j o b b o l e . c o m / 1 8 3 0 4 / 译 者 ：   黄 小 非 经 过 修 改 后 ， 唯 一 变 化 的 就 是 变 量 名 ， 而 且 代 码 变 得 简 单 易 懂 了 。 现 在 对 于 每 个 _ t o t a l ， 就 不 存 在 二 义 性 的 问 题 了 。 看 看 我 们 发 现 了 什 么 ： 原 先 i f 语 句 中 的 两 个 比 较 变 量 的 位 置 写 反 了 。 有 效 的 命 名 方 法 让 我 们 能 够 更 快 地 发 现 错 误 。 通 常 ， 我 们 都 认 为 用 数 字 作 为 变 量 的 结 尾 是 不 好 的 命 名 方 法 ， 但 是 有 一 个 例 外 。 如 果 变 量 描 述 的 实 体 本 身 就 是 以 数 字 结 尾 的 ， 那 变 量 名 最 好 也 是 以 数 字 结 尾 。 比 如 ， 如 果 我 们 要 定 义 一 个 S H A - 1 哈 希 实 体 ， 那 干 脆 就 把 它 命 名 为 $ s h a 1 , 这 样 就 很 好 ， 你 完 全 没 有 必 要 把 它 搞 成 $ s h a _ o n e ， 然 后 来 避 免 在 变 量 名 中 使 用 数 字 。 在 我 完 成 了 对 本 文 的 第 一 版 后 ， 我 创 立 了 自 己 的 命 名 规 则 ， 并 使 用 P e r l : : C r i t i c 包 来 检 测 上 述 提 到 的 两 种 命 名 问 题 。 我 制 作 的 插 件 P e r l : : C r i t i c : : B a n g s   可 以 检 测 出 这 两 种 问 题 ： P r o h i b i t V a g u e N a m e s   和   P r o h i b i t N u m b e r N a m e s . 还 有 哪 些 其 他 的 糟 糕 的 命 名 方 法 逼 得 你 发 疯 ？ 你 自 己 有 去 做 些 什 么 纠 正 这 些 错 误 么 ？ 阅 读 原 文
回复

举报

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

本版积分规则

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

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