搜索

[23398] 2014-12-20_为什么我要竖向对齐程序代码

文档创建者：s7ckTeam
浏览次数：5
最后更新：2025-01-18
2014-12-20_为什么我要竖向对齐程序代码 为 什 么 我 要 竖 向 对 齐 程 序 代 码 L i n u x 中 国   2 0 1 4 - 1 2 - 2 0 最 近 在 H a c k e r N e w s 上 L i n u x 内 核 编 码 风 格 的 讨 论 非 常 热 闹 。 讨 论 的 进 行 中 ， 我 的 一 个 回 复 触 发 了 另 外 一 场 关 于 是 否 应 该 竖 向 对 齐 代 码 的 口 水 仗 。 我 坚 持 我 的 观 点 ！ 下 面 让 我 来 解 释 一 下 为 什 么 要 竖 向 对 齐 。 为 什 么 要 竖 向 对 齐 代 码 ？ 举 一 个 简 单 的 例 子 ： 1 .   i n t   r o b e r t _ a g e   =   3 2 ; 2 .   i n t   a n n a l o u i s e _ a g e   =   2 5 ; 3 .   i n t   b o b _ a g e   =   2 5 0 ; 4 .   i n t   d o r o t h y _ a g e   =   5 6 ; 相 较 而 言 ， 下 面 的 写 法 更 易 读 ： 1 .   i n t   r o b e r t _ a g e           =   3 2 ; 2 .   i n t   a n n a l o u i s e _ a g e   =   2 5 ; 3 .   i n t   b o b _ a g e                 =   2 5 0 ; 4 .   i n t   d o r o t h y _ a g e         =   5 6 ; 只 要 用 眼 睛 一 扫 ， 我 们 就 能 发 现 ” b o b _ a g e ” 数 字 异 常 。 我 可 以 去 轻 松 的 识 别 这 些 变 量 都 是 数 字 ， 不 需 要 拿 眼 睛 一 个 个 对 比 。 这 种 编 码 风 格 并 不 是 被 广 泛 的 接 受 。 所 以 ， 我 需 要 解 释 一 些 这 种 风 格 的 好 处 。 代 码 的 可 读 性 9 0 % 的 编 程 活 动 是 为 了 解 决 问 题 。 另 外 9 0 % 是 用 来 理 解 代 码 是 如 何 解 决 问 题 的 。
阅 读 代 码 跟 阅 读 小 说 没 多 大 区 别 。 我 们 希 望 作 者 能 把 他 的 想 法 写 明 白 ， 不 需 要 陈 词 滥 调 长 篇 累 牍 ， 但 同 时 要 遵 守 所 使 用 的 语 言 的 语 法 。 事 实 上 ， L i n u x 内 核 编 码 风 格 里 十 分 强 调 这 一 点 。 你 给 变 量 的 命 名 同 它 的 作 用 同 等 重 要 。 看 一 下 下 面 的 这 段 代 码 ： 1 .   v a r   t h i n G = d o I t ( t h e s t u f f , M O R E _ s T u f f ) ;   / *   L O L !   * / 就 算 你 是 十 分 解 这 段 代 码 ， 你 读 起 它 来 也 十 分 费 劲 。 1 .   v a r   t o t a l B i l l   =   a p p l y _ t a x ( i n i t i a l B i l l ,   t a x R a t e ) ; 通 过 给 予 变 量 有 意 义 的 命 名 ， 空 格 ， 大 小 写 区 分 ， 我 们 能 让 这 段 代 码 更 清 晰 。 这 意 味 着 接 手 我 们 的 代 码 的 下 一 位 程 序 员 能 更 容 易 的 理 解 它 。 为 什 么 要 使 用 M o n o s p a c e 字 体 ？ 关 于 代 码 编 辑 器 应 该 使 用 m o n o s p a c e 字 体 还 是 p r o p o r t i o n a l 字 体 的 争 论 ， 从 未 停 息 也 不 会 停 息 ， 两 派 人 各 有 所 好 。 有 些 异 教 徒 会 告 诉 你 p r o p o r t i o n a l   字 体 是 最 好 的 — — 忽 略 这 些 人 吧 。 最 终 是 为 可 读 性 。 什 么 方 法 能 最 简 单 的 帮 助 我 们 理 解 代 码 ？ 所 以 I D E 才 会 有 代 码 高 亮 配 色 ， 这 样 你 就 能 轻 松 的 分 辨 “ f o o ” 究 竟 是 一 个 函 数 ， 是 一 个 变 量 ， 是 一 个 常 量 ， 还 是 一 个 注 释 。 只 要 是 能 帮 助 我 们 理 解 代 码 的 东 西 都 是 好 东 西 ！ 编 辑 器 的 问 题 有 趣 的 是 ， 我 遇 到 的 很 多 批 评 的 声 音 不 是 说 代 码 竖 向 对 齐 的 好 坏 ， 而 是 批 评 我 的 代 码 编 辑 器 不 行 。 你 这 样 做 会 破 坏 使 用 d i f f 对 比 版 本 差 异 时 的 可 读 性 和 有 效 性 。 比 如 ， 本 来 只 是 一 行 是 有 一 个 变 量 有 b u g ， 你 能 为 了 对 齐 变 量 改 动 了 很 多 行 ， 影 响 了 查 看 关 键 修 改 处 。 也 有 能 够 忽 略 空 格 的 d i f f 技 术 ， 但 至 少 你 这 样 做 得 不 偿 失 。 A n d r e a s   v a n   C r a n e n b u r g h … 还 有 … 假 如 说 ， 你 有 5 0 行 代 码 要 竖 向 对 齐 ， 你 把 所 有 的 值 对 对 齐 距 离 最 远 的 那 一 行 ， 而 增 加 一 个 更 大 距 离 的 行 ， 你 需 要 修 改 5 0 行 。 我 就 遇 到 过 这 样 的 问 题 ， 最 终 发 现 这 样 做 是 错 误 的 。 s c r o l l a w a y 他 们 说 的 是 对 的 — — 在 某 些 情 况 下 。 但 关 键 是 他 们 不 会 使 用 更 好 工 具 。 我 记 得 E l a s t i c   T a b s t o p s 提 供 的 一 个 技 巧 — — 如 何 自 动 对 齐 代 码 块 ：
原 文 ：   h t t p s : / / s h k s p r . m o b i / b l o g / 2 0 1 4 / 1 1 / w h y - i - v e r t i c a l l y - a l i g n - m y - c o d e - a n d - y o u - s h o u l d - t o o / 译 文 ：   h t t p : / / w w w . t e c h u g . c o m / w h y - i - v e r t i c a l l y - a l i g n - m y - c o d e 正 确 的 工 具 能 轻 松 的 完 成 这 样 的 任 务 。 计 算 机 就 是 用 来 为 我 们 干 这 些 枯 燥 、 重 复 的 事 情 的 - C P U 的 工 作 很 廉 价 ， 我 们 可 以 “ 浪 费 ” C P U 的 工 作 来 让 我 们 的 代 码 更 清 晰 可 读 。 在 L i n u x   内 核 代 码 中 还 有 大 量 的 例 子 能 说 明 竖 向 对 齐 代 码 能 让 代 码 更 适 合 人 类 阅 读 。 竖 向 对 齐 代 码 并 不 是 在 所 有 情 况 下 都 适 用 — — 但 对 于 大 多 数 情 况 ， 它 的 好 处 是 大 大 的 。 代 码 是 我 们 表 达 我 们 的 思 想 的 媒 介 。 如 果 你 的 工 具 使 得 理 解 这 些 思 想 更 困 难 ， 那 说 明 工 具 需 要 改 变 ， 而 不 是 我 们 。 阅 读 原 文
回复

举报

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

本版积分规则

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

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