搜索

[24747] 2016-02-25_提高代码质量：如何编写函数

文档创建者：s7ckTeam
浏览次数：1
最后更新：2025-01-18
2016-02-25_提高代码质量：如何编写函数 提 高 代 码 质 量 ： 如 何 编 写 函 数 狼 狼 的 蓝 胖 子   L i n u x 中 国   2 0 1 6 - 0 2 - 2 5 转 载 自 ：   h t t p : / / l u o p q . c o m / 2 0 1 6 / 0 2 / 2 1 / w r i t e - g o o d - f u n c t i o n /   作 者 ：   狼 狼 的 蓝 胖 子 函 数 是 实 现 程 序 功 能 的 最 基 本 单 位 ， 每 一 个 程 序 都 是 由 一 个 个 最 基 本 的 函 数 构 成 的 。 写 好 一 个 函 数 是 提 高 程 序 代 码 质 量 最 关 键 的 一 步 。 本 文 就 函 数 的 编 写 ， 从 函 数 命 名 ， 代 码 分 布 ， 技 巧 等 方 面 入 手 ， 谈 谈 如 何 写 好 一 个 可 读 性 高 、 易 维 护 ， 易 测 试 的 函 数 。 命 名 命 名 首 先 从 命 名 说 起 ， 命 名 是 提 高 可 读 性 的 第 一 步 。 如 何 为 变 量 和 函 数 命 名 一 直 是 开 发 者 心 中 的 痛 点 之 一 ， 对 于 母 语 非 英 语 的 我 们 来 说 ， 更 是 难 上 加 难 。 下 面 我 来 说 说 如 何 为 函 数 命 名 的 一 些 想 法 和 感 受 ： 采 用 统 一 的 命 名 规 则 采 用 统 一 的 命 名 规 则 在 谈 及 如 何 为 函 数 取 一 个 准 确 而 优 雅 的 名 字 之 前 ， 首 先 最 重 要 的 是 要 有 统 一 的 命 名 规 则 。 这 是 提 高 代 码 可 读 性 的 最 基 础 的 准 则 。 帕 斯 卡 命 名 法 和 驼 峰 命 名 法 是 目 前 比 较 流 行 的 两 种 规 则 ， 不 同 语 言 采 用 的 规 则 可 能 不 一 样 ， 但 是 要 记 住 一 点 ： 保 持 团 队 和 个 人 风 格 一 致 。 1 、 帕 斯 卡 命 名 法 、 帕 斯 卡 命 名 法 帕 斯 卡 命 名 法 简 单 地 说 就 是 ： 多 个 单 词 组 成 一 个 名 称 时 ， 每 个 单 词 的 首 字 母 大 写 。 比 如 ： 在 C # 中 ， 这 种 命 名 法 常 用 于 类 、 属 性 ， 函 数 等 等 ， 在 J S 中 ， 构 造 函 数 也 推 荐 采 用 这 种 方 式 命 名 。 1 .   p u b l i c   v o i d   S e n d M e s s a g e   ( ) ; 2 .   p u b l i c   v o i d   C a l c u l a t e P r i c e   ( ) ;
2 、 驼 峰 命 名 法 、 驼 峰 命 名 法 驼 峰 命 名 法 和 帕 斯 卡 命 名 法 很 类 似 ， 多 个 单 词 组 成 一 个 名 称 时 ， 第 一 个 单 词 全 部 小 写 ， 后 面 单 词 首 字 母 大 写 。 比 如 ： 驼 峰 命 名 法 一 般 用 于 字 段 、 局 部 变 量 、 函 数 参 数 等 等 。 在 J S 中 ， 函 数 也 常 用 此 方 法 命 名 。 采 用 哪 种 命 名 规 则 并 不 绝 对 ， 最 重 要 的 是 要 遵 守 团 队 约 定 ， 语 言 规 范 。 尽 可 能 完 整 地 描 述 函 数 所 做 的 所 有 事 情 尽 可 能 完 整 地 描 述 函 数 所 做 的 所 有 事 情 有 的 开 发 者 可 能 觉 得 相 较 于 长 函 数 名 来 说 ， 短 函 数 名 看 起 来 可 能 更 简 洁 ， 看 起 来 也 更 舒 服 。 但 是 通 常 来 说 ， 函 数 名 称 越 短 其 描 述 的 意 思 越 抽 象 。 函 数 使 用 者 对 函 数 的 第 一 印 象 就 是 函 数 名 称 ， 进 而 了 解 函 数 的 功 能 ， 我 们 应 该 尽 可 能 地 描 述 到 函 数 所 做 的 所 有 事 情 ， 防 止 使 用 者 不 知 道 或 误 解 造 成 潜 在 的 错 误 。 举 个 例 子 ， 假 设 我 们 做 一 个 添 加 评 论 的 功 能 ， 添 加 完 毕 后 并 返 回 评 论 总 数 量 ， 如 何 命 名 比 较 合 适 呢 ？ 3 .   这 只 是 简 单 的 一 个 例 子 ， 实 际 开 发 中 可 能 会 遇 到 得 更 多 复 杂 的 情 况 ， 单 一 职 责 原 则 是 我 们 开 发 函 数 要 遵 守 的 准 则 ， 但 是 有 时 候 无 法 做 到 函 数 单 一 职 责 时 ， 请 记 得 函 数 名 应 该 尽 可 能 地 描 述 所 有 事 情 。 当 你 无 法 命 名 一 个 函 数 时 ， 应 该 分 析 一 下 ， 这 个 函 数 的 编 写 是 否 科 学 ， 有 什 么 办 法 可 以 去 优 化 它 。 采 用 准 确 的 描 述 动 词 采 用 准 确 的 描 述 动 词 这 一 点 对 母 语 非 英 语 的 开 发 者 来 说 应 该 是 比 较 难 的 一 点 ， 想 要 提 高 这 方 面 的 能 力 ， 最 主 要 的 还 是 要 提 高 词 汇 量 ， 多 阅 读 优 秀 代 码 积 累 经 验 。 这 里 简 单 说 说 我 自 己 的 一 些 感 想 和 看 法 ： 1 、 不 要 采 用 太 抽 象 广 泛 的 单 词 、 不 要 采 用 太 抽 象 广 泛 的 单 词 很 多 开 发 人 员 会 采 用 一 个 比 较 宽 泛 的 动 词 来 为 函 数 命 名 ， 最 典 型 的 一 个 例 子 就 是 g e t 这 个 单 词 。 我 们 平 时 开 发 中 经 常 会 通 过 各 种 不 同 的 方 式 拿 到 数 据 ， 但 是 每 一 种 方 式 都 用 g e t 就 有 点 太 抽 象 了 。 具 体 如 何 命 名 ， 要 具 体 分 析 ： （ 1 ） 简 单 的 返 回 数 据 1 .   v a r   s e n d M e s s a g e   =   f u n c t i o n   ( )   { } ; 2 .   v a r   c a l c u l a t e P r i c e   =   f u n c t i o n   ( )   { } ; 1 .   / /   描 述 不 够 完 整 的 函 数 名 2 .   v a r   c o u n t   =   f u n c t i o n   a d d C o m m e n t ( )   { } ; 4 .   / /   描 述 完 整 的 函 数 名 5 .   v a r   c o u n t   =   f u n c t i o n   a d d C o m m e n t A n d R e t u r n C o u n t ( )   { } ; 1 .   P e r s o n . p r o t o t y p e . g e t F u l l N a m e   =   f u n c t i o n ( )   { 2 .           r e t u r n   t h i s . f i r s t N a m e   =   t h i s . l a s t N a m e ; 3 .   }
（ 2 ） 从 远 程 获 取 数 据 （ 3 ） 从 本 地 存 储 加 载 数 据 （ 4 ） 通 过 计 算 获 取 数 据 （ 5 ） 从 数 组 中 查 找 数 据 （ 6 ） 从 一 些 数 据 生 成 或 得 到 这 是 一 个 简 单 的 例 子 ， 我 们 平 时 开 发 中 遇 到 的 情 况 肯 定 会 复 杂 得 多 ， 关 键 还 是 靠 单 词 的 积 累 ， 多 阅 读 优 秀 源 码 下 面 是 整 理 的 一 些 常 用 的 对 仗 词 ， 大 家 可 以 参 考 使 用 3 .   } 1 .   v a r   f e t c h P e r s o n s   =   f u n c t i o n   ( )   { 2 .           . . . 3 .           $ . a j a x ( { 4 .           } ) 5 .   } 1 .   v a r   l o a d P e r s o n s   =   f u n c t i o n   ( )   { } ; 1 .   v a r   c a l c u l a t e T o t a l   =   f u n c t i o n   ( )   { } ; 1 .   v a r   f i n d S t h   =   f u n c t i o n   ( a r r )   { } ; 1 .   v a r   c r e a t e S t h   =   f u n c t i o n   ( d a t a )   { } ; 2 .   v a r   b u i l d S t h   =   f u n c t i o n   ( d a t a )   { } ; 3 .   v a r   p a r s e S t h   =   f u n c t i o n ( d a t a )   { } ; 1 .   a d d / r e m o v e                 i n c r e m e n t / d e c r e m e n t               o p e n / c l o s e 2 .   b e g i n / e n d                         i n s e r t / d e l e t e                                             s h o w / h i d e 3 .   c r e a t e / d e s t o r y         l o c k / u n l o c k                                                 s o u r c e / t a r g e t 4 .   f i r s t / l a s t                             m i n / m a x                                                           s t a r / s t o p
根 据 不 同 项 目 和 需 求 制 定 好 命 名 规 则 根 据 不 同 项 目 和 需 求 制 定 好 命 名 规 则 这 一 点 也 是 很 重 要 的 ， 尤 其 是 在 团 队 合 作 中 ， 不 同 的 项 目 和 需 求 可 能 导 致 的 不 同 的 命 名 规 则 。 比 如 我 们 通 常 采 用 的 命 名 规 则 是 动 宾 结 构 ， 也 就 是 动 词 在 前 ， 名 词 灾 后 。 但 是 有 一 些 项 目 ， 比 如 数 据 接 口 等 项 目 中 ， 有 的 团 队 会 采 用 名 字 在 前 ， 动 词 在 后 的 形 式 ， 例 如 ： 这 种 的 好 处 是 看 到 前 面 的 名 词 ， 比 如 P r o d u c t s G e t ， 就 能 很 快 的 知 道 这 是 产 品 相 关 的 数 据 接 口 。 当 然 这 个 并 不 是 绝 对 的 ， 关 键 还 是 要 团 队 共 同 制 定 和 遵 守 同 一 套 命 名 规 则 。 函 数 参 数 函 数 参 数 函 数 使 用 者 在 调 用 函 数 时 ， 必 须 严 格 遵 守 函 数 定 义 的 参 数 ， 这 对 函 数 的 易 用 性 ， 可 测 试 性 等 方 面 都 是 至 关 重 要 的 。 下 面 我 从 几 个 方 面 来 谈 谈 关 于 如 何 优 化 好 函 数 参 数 的 一 些 想 法 。 参 数 数 量 参 数 数 量 毫 无 疑 问 ， 函 数 参 数 越 多 ， 函 数 的 易 用 性 就 越 差 ， 因 为 使 用 者 需 要 严 格 眼 中 参 数 列 表 依 次 输 入 参 数 ， 如 果 某 个 参 数 输 错 ， 将 导 致 不 可 意 料 的 结 果 。 但 是 ， 函 数 参 数 就 一 定 越 少 越 好 吗 ？ 我 们 来 看 看 下 面 的 例 子 ： 在 这 个 例 子 中 ， 我 们 通 过 c a l c u l a t e P r i c e 这 个 函 数 来 计 算 价 格 ， 函 数 不 接 收 任 何 参 数 ， 直 接 通 过 两 个 全 局 变 量 u n i t P r i c e 和 c o u n t 进 行 计 算 。 这 种 函 数 的 定 义 对 使 用 者 来 说 非 常 方 便 ， 直 接 调 用 即 可 ， 不 用 输 入 任 何 参 数 。 但 是 这 里 可 能 会 有 潜 在 的 b u g ： 全 局 变 量 可 能 在 其 他 地 方 被 修 改 成 其 他 值 了 ， 难 以 进 行 4 .   f i r s t / l a s t                             m i n / m a x                                                           s t a r / s t o p 5 .   g e t / p u t                                 n e x t / p r e v i o u s                                           u p / d o w n           6 .   g e t / s e t                                 o l d / n e w 1 .   p u b l i c   s t a t i c   P r o d u c t [ ]   P r o d u c t s G e t ( ) { } ; 2 .   p u b l i c   s t a t i c   P r o d u c t [ ]   P r o d u c t s D e l ( ) { } ; 3 .   p u b l i c   s t a t i c   C u s t o m e r [ ]   C u s t o m e r D e l ( ) { } ; 4 .   p u b l i c   s t a t i c   C u s t o m e r [ ]   C u s t o m e r D e l ( ) { } ; 1 .   v a r   c o u n t   =   0 ; 2 .   v a r   u n i t P r i c e   =   1 . 5 ; 3 .   . . . . 4 .   . . . 5 .   v a r   c a l c u l a t e P r i c e   =   f u n c t i o n   ( )   { 6 .           r e t u r n   c o u n t   *   u n i t P r i c e ; 7 .   }
单 元 测 试 等 等 问 题 。 所 以 ， 这 个 函 数 可 以 传 入 数 量 和 价 格 信 息 ： 这 种 方 式 下 ， 函 数 使 用 者 在 使 用 时 ， 要 传 入 参 数 进 行 调 用 ， 避 免 了 全 局 变 量 可 能 存 在 的 问 题 。 另 外 也 降 低 了 耦 合 ， 提 高 了 可 测 试 性 ， 在 测 试 的 时 候 就 不 必 依 赖 于 全 局 变 量 。 当 然 ， 在 保 证 函 数 不 依 赖 于 全 局 变 量 和 测 试 性 的 情 况 下 ， 函 数 参 数 还 是 越 少 越 好 。 《 代 码 大 全 》 中 提 出 将 函 数 的 参 数 限 制 在 7 个 以 内 ， 这 个 可 以 作 为 我 们 的 参 考 。 有 的 时 候 ， 我 们 不 可 避 免 地 要 使 用 超 过 1 0 个 以 上 函 数 ， 在 这 中 情 况 下 ， 我 们 可 以 考 虑 将 类 似 的 参 数 构 造 成 一 个 类 ， 我 们 来 看 看 一 个 典 型 的 例 子 。 我 相 信 大 家 平 时 一 定 做 过 这 样 的 功 能 ， 列 表 筛 选 ， 其 中 涉 及 到 各 种 条 件 的 筛 选 ， 排 序 ， 分 页 等 等 功 能 ， 如 果 将 参 数 一 个 一 个 地 列 出 来 必 定 会 很 长 ， 例 如 ： 这 是 一 个 筛 选 酒 店 的 函 数 ， 其 中 的 参 数 分 别 是 城 市 ， 入 住 和 退 房 时 间 ， 价 格 ， 星 级 ， 位 置 ， 是 否 有 w i f i ， 是 否 有 早 餐 ， 排 序 ， 页 码 等 等 ， 实 际 的 情 况 可 能 会 更 多 。 在 这 种 参 数 特 别 多 的 情 况 下 ， 我 们 可 以 考 虑 将 一 些 相 似 的 参 数 提 取 成 类 出 来 ： 6 .   1 4 .   1 .   v a r   c a l c u l a t e P r i c e   =   f u n c t i o n ( c o u n t ,   u n i t P r i c e )   { 2 .           r e t u r n   c o u n t   *   u n i t P r i c e ; 3 .   } 1 .   v a r   f i l t e r H o t e l   =   f u n c t i o n   ( c i t y ,   c h e c k I n ,   c h e c k O u t ,   p r i c e ,   s t a r ,   p o s i t i o n ,   w i f i ,   m e a l ,   s o r t ,   p a g e I n d e x )   { } 1 .   f u n c t i o n   D a t e P l a c e   ( c i t y ,   c h e c k I n ,   c h e c k O u t ) { 2 .           t h i s . c i t y   =   c i t y ; 3 .           t h i s . c h e c k I n   =   c h e c k I n ; 4 .           t h i s . c h e c k O u t   =   c h e c k O u t 5 .   } 7 .   f u n c t i o n   H o t e l F e a t u r e   ( p r i c e ,   s t a r ,   p o s i t i o n ,   w i f i ,   m e a l ) { 8 .           t h i s . p r i c e   =   p r i c e ; 9 .           t h i s . s t a r   =   s t a r ; 1 0 .           t h i s . p o s i t i o n   =   p o s i t i o n ; 1 1 .           t h i s . w i f i   =   w i f i ; 1 2 .           t h i s . m e a l   =   m e a l ; 1 3 .   } 1 5 .   v a r   f i l t e r H o t e l   =   f u n c t i o n   ( d a t e P l c e ,   h o t e l F e a t u r e ,   s o r t ,   p a g e I n d e x )   { } ;
将 多 个 参 数 提 取 成 对 象 了 ， 虽 然 对 象 数 量 增 多 了 ， 但 是 函 数 参 数 更 清 晰 了 ， 调 用 起 来 也 更 方 便 了 。 尽 量 不 要 使 用 尽 量 不 要 使 用 b o o l 类 型 作 为 参 数 类 型 作 为 参 数 有 的 时 候 ， 我 们 会 写 出 使 用 b o o l 作 为 参 数 的 情 况 ， 比 如 ： 7 .   如 果 没 有 注 释 ， 使 用 者 看 到 这 样 的 代 码 ： g e t P r o d u c t ( t r u e ) ， 他 肯 定 搞 不 清 楚 t r u e 是 代 表 什 么 意 思 ， 还 要 去 查 看 函 数 定 义 才 能 明 白 这 个 函 数 是 如 何 使 用 的 。 这 就 意 味 着 这 个 函 数 不 够 清 晰 ， 就 应 该 考 虑 去 优 化 它 。 通 常 有 两 种 方 式 去 优 化 它 ： 1 .   将 函 数 一 分 为 二 ， 分 成 两 个 函 数 g e t F i n i s h e d P r o d u c t 和 g e t U n F i n i s h e d P r o d u c t 2 .   将 b o o l 转 换 成 有 意 义 的 枚 举 g e t P r o d u c t ( P r o d u c t S t a t u s ) 不 要 修 改 输 入 参 数 不 要 修 改 输 入 参 数 如 果 输 入 参 数 在 函 数 内 被 修 改 了 ， 很 有 可 能 造 成 潜 在 的 b u g ， 而 且 使 用 者 不 知 道 调 用 函 数 后 居 然 会 修 改 函 数 参 数 。 正 确 使 用 输 入 参 数 的 做 法 应 该 是 只 传 入 参 数 用 于 函 数 调 用 。 如 果 不 可 避 免 地 要 修 改 ， 一 定 要 在 注 释 中 说 明 。 尽 量 不 要 使 用 输 出 参 数 尽 量 不 要 使 用 输 出 参 数 使 用 输 出 参 数 说 明 这 个 函 数 不 只 做 了 一 件 事 情 ， 而 且 使 用 者 使 用 的 时 候 可 能 还 会 感 到 困 惑 。 正 确 的 方 式 应 该 是 分 解 函 数 ， 让 函 数 只 做 一 件 事 。 编 写 函 数 体 编 写 函 数 体 函 数 体 就 是 实 现 函 数 功 能 的 整 个 逻 辑 ， 是 一 个 函 数 最 关 键 的 地 方 。 下 面 我 谈 谈 关 于 函 数 代 码 编 写 的 一 些 个 人 想 法 。 相 关 操 作 放 在 一 起 相 关 操 作 放 在 一 起 有 的 时 候 ， 我 们 会 在 一 个 函 数 内 进 行 一 系 列 的 操 作 来 完 成 一 个 功 能 ， 比 如 ： 1 .   v a r   g e t P r o d u c t   =   f u n c t i o n ( f i n i s h e d )   { 2 .           i f ( f i n i s h e d ) { 3 .           } 4 .           e l s e { 5 .           } 6 .   } 8 .   / /   调 用 9 .   g e t P r o d u c t ( t r u e ) ; 1 .   v a r   c a l c u l a t e T o t a l P r i c e   =   f u n c t i o n ( )     { 2 .           v a r   r o o m C o u n t   =   g e t R o o m C o u n t ( ) ; 3 .           v a r   m e a l C o u n t   =   g e t M e a l C o u n t ( ) ;
4 .   7 .   这 段 代 码 计 算 了 房 间 价 格 和 早 餐 价 格 ， 然 后 将 两 者 相 加 返 回 总 价 格 。 这 段 代 码 乍 一 看 ， 没 有 什 么 问 题 ， 但 是 我 们 分 析 代 码 ， 我 们 先 是 分 别 获 取 了 房 间 数 量 和 早 餐 数 量 ， 然 后 再 通 过 房 间 数 量 和 早 餐 数 量 分 别 计 算 两 者 的 价 格 。 这 种 情 况 下 ， 房 间 数 量 和 计 算 房 间 价 格 的 代 码 分 散 在 了 两 个 位 置 ， 早 餐 价 格 的 计 算 也 是 分 散 到 了 两 个 位 置 。 也 就 是 两 部 分 相 关 的 代 码 分 散 在 了 各 处 ， 这 样 阅 读 起 代 码 来 逻 辑 会 略 显 不 通 ， 代 码 组 织 不 够 好 。 我 们 应 该 让 相 关 的 语 句 和 操 作 放 在 一 起 ， 也 有 利 于 重 构 代 码 。 我 们 修 改 如 下 ： 4 .   7 .   我 们 将 相 关 的 操 作 放 在 一 起 ， 这 样 代 码 看 起 来 更 清 晰 了 ， 而 且 也 更 容 易 重 构 了 。 尽 量 减 少 代 码 嵌 套 尽 量 减 少 代 码 嵌 套 我 们 平 时 写 i f ， s w i t c h 或 f o r 语 句 是 常 有 的 事 儿 ， 也 一 定 写 过 多 层 i f 或 f o r 语 句 嵌 套 的 情 况 ， 如 果 代 码 里 的 嵌 套 超 过 3 层 ， 阅 读 起 来 就 会 非 常 困 难 了 。 我 们 应 该 尽 量 避 免 代 码 嵌 套 多 层 ， 最 好 不 要 超 过 2 层 。 下 面 我 来 说 说 我 平 时 一 些 减 少 嵌 套 的 技 巧 或 方 法 。 i f 语 句 嵌 套 的 问 题 语 句 嵌 套 的 问 题 多 层 i f 语 句 嵌 套 是 常 有 的 事 情 ， 有 什 么 好 的 方 法 可 以 减 少 嵌 套 呢 ？ 1 、 尽 早 终 止 函 数 或 返 回 数 据 、 尽 早 终 止 函 数 或 返 回 数 据 如 果 符 合 某 个 条 件 下 可 以 直 接 终 止 函 数 ， 则 应 该 将 这 个 条 件 放 在 第 一 位 。 我 们 来 看 看 下 面 的 例 子 。 5 .           v a r   r o o m P r i c e   =   g e t R o o m P r i c e ( r o o m C o u n t ) ; 6 .           v a r   m e a l P r i c e   =   g e t M e a l P r i c e ( m e a l C o u n t ) ; 8 .           r e t u r n   r o o m P r i c e   +   m e a l P r i c e ; 9 .   } 1 .   v a r   c a l c u l a t e T o t a l P r i c e   =   f u n c t i o n ( )     { 2 .           v a r   r o o m C o u n t   =   g e t R o o m C o u n t ( ) ; 3 .           v a r   r o o m P r i c e   =   g e t R o o m P r i c e ( r o o m C o u n t ) ; 5 .           v a r   m e a l C o u n t   =   g e t M e a l C o u n t ( ) ; 6 .           v a r   m e a l P r i c e   =   g e t M e a l P r i c e ( m e a l C o u n t ) ; 8 .           r e t u r n   r o o m P r i c e   +   m e a l P r i c e ; 9 .   } 1 .   i f ( c o n d i t i o n 1 )   { 2 .           i f ( c o n d i t i o n 2 ) { 3 .                   i f ( c o n d i t i o n 3 ) {
  这 段 代 码 中 i f 语 句 嵌 套 了 3 层 ， 看 起 来 已 经 很 复 杂 了 ， 我 们 可 以 将 最 后 面 的 r e t u r n 提 取 到 最 前 面 去 。 这 段 代 码 中 ， 我 们 把 c o n d i t i o n 1 等 于 f a l s e 的 语 句 提 取 到 前 面 ， 直 接 终 止 函 数 ， 将 多 层 嵌 套 的 i f 语 句 重 构 成 只 有 一 层 i f 语 句 ， 代 码 也 更 清 晰 了 。 注 意 ： 一 般 情 况 下 ， 我 们 写 i f 语 句 会 将 条 件 为 t r u e 的 情 况 写 在 前 面 ， 这 也 比 较 符 合 我 们 的 思 维 习 惯 。 如 果 是 多 层 嵌 套 的 情 况 ， 应 该 优 先 减 少 i f 语 句 的 嵌 套 2 、 不 适 用 、 不 适 用 i f 语 句 或 语 句 或 s w i t c h 语 句 语 句 条 件 语 句 一 般 来 说 是 不 可 避 免 的 ， 有 的 时 候 ， 我 们 要 判 断 很 多 条 件 就 会 写 很 多 i f - e l s e i f 语 句 ， 嵌 套 的 话 ， 就 更 加 麻 烦 了 。 如 果 有 一 天 增 加 了 新 需 求 ， 我 们 就 要 去 增 加 一 个 i f 分 支 语 句 ， 这 样 不 仅 修 改 起 来 麻 烦 ， 而 且 容 易 出 错 。 《 代 码 大 全 》 提 出 的 表 驱 动 法 可 以 有 效 地 解 决 i f 语 句 带 来 的 问 题 。 我 们 来 看 下 面 这 个 例 子 ： 4 .                   } 5 .                   e l s e { 6 .                           r e t u r n ; 7 .                   }         8 .           } 9 .           e l s e { 1 0 .                   r e t u r n ; 1 1 .           }         1 2 .   } 1 3 .   e l s e   { 1 4 .           r e t u r n ; 1 5 .   } 1 .   i f ( ! c o n d i t i o n 1 ) { 2 .           r e t u r n ; 3 .   } 4 .   i f ( ! c o n d i t i o n 2 ) { 5 .           r e t u r n ; 6 .   } 7 .   i f ( ! c o n d i t i o n 3 ) { 8 .           r e t u r n ; 9 .   } 1 0 .   / / d o S t h 1 .   i f ( c o n d i t i o n   = =   “ c a s e 1 ” ) {
这 段 代 码 分 别 依 次 判 断 了 四 种 情 况 ， 如 果 再 增 加 一 种 情 况 ， 我 们 就 要 再 新 增 一 个 i f 分 支 ， 这 样 就 可 能 造 成 潜 在 的 问 题 ， 如 何 去 优 化 这 段 代 码 呢 ？ 我 们 可 以 采 用 一 个 M a p 或 D i c t i o n a r y 来 将 每 一 种 情 况 和 相 应 值 一 一 对 应 。 通 过 m a p 优 化 后 ， 整 个 代 码 不 仅 更 加 简 洁 ， 修 改 起 来 也 更 方 便 而 且 不 易 出 错 了 。 当 然 ， 很 多 时 候 我 们 的 条 件 判 断 语 句 并 不 是 这 么 简 单 的 ， 可 能 会 涉 及 到 复 杂 的 逻 辑 运 算 ， 大 家 可 以 查 看 《 代 码 大 全 》 第 1 8 章 ， 其 中 有 详 细 的 介 绍 。 3 、 提 取 内 层 嵌 套 为 一 个 函 数 进 行 调 用 、 提 取 内 层 嵌 套 为 一 个 函 数 进 行 调 用 多 层 嵌 套 的 时 候 ， 我 们 还 可 以 将 内 层 嵌 套 提 取 到 一 个 新 的 函 数 中 ， 然 后 调 用 该 函 数 ， 这 样 代 码 也 就 更 清 晰 了 。 f o r 循 环 嵌 套 优 化 循 环 嵌 套 优 化 f o r 循 环 嵌 套 相 比 于 i f 嵌 套 来 说 更 加 复 杂 ， 阅 读 起 来 会 更 麻 烦 ， 下 面 说 说 几 点 要 注 意 的 东 西 ： 1 .   最 多 只 能 两 层 f o r 循 环 嵌 套 2 .   提 取 内 层 循 环 到 新 函 数 中 3 .   多 层 循 环 时 ， 不 要 简 单 地 位 索 引 变 量 命 名 为 i ， j ， k 等 ， 容 易 造 成 混 淆 ， 要 有 具 体 的 意 思 提 取 复 杂 逻 辑 ， 语 义 化 提 取 复 杂 逻 辑 ， 语 义 化 1 .   i f ( c o n d i t i o n   = =   “ c a s e 1 ” ) { 2 .           r e t u r n   1 ; 3 .   } 4 .   e l s e i f ( c o n d i t i o n   = =   “ c a s e 2 ” ) { 5 .           r e t u r n   2 ; 6 .   } 7 .   e l s e i f ( c o n d i t i o n   = =   “ c a s e 3 ” ) { 8 .           r e t u r n   3 ; 9 .   } 1 0 .   e l s e i f ( c o n d i t i o n   = =   “ c a s e 4 ” ) { 1 1 .           r e t u r n   4 ; 1 2 .   } 1 .   v a r   m a p   =   { 2 .           " c a s e 1 " : 1 , 3 .           " c a s e 2 " : 2 , 4 .           " c a s e 3 " : 3 , 5 .           " c a s e 4 " : 4 6 .   } 7 .   r e t u r n   m a p [ c o n d i t i o n ] ;
有 的 时 候 ， 我 们 会 写 出 一 些 比 较 复 杂 的 逻 辑 ， 阅 读 代 码 的 人 看 到 后 可 能 搞 不 清 楚 要 做 什 么 ， 这 个 时 候 ， 就 应 该 提 取 出 这 段 复 杂 的 逻 辑 代 码 。 这 段 代 码 表 示 当 年 龄 大 于 1 8 并 且 是 男 性 的 话 ， 可 以 d o S t h ， 但 是 还 是 不 够 清 晰 ， 可 以 将 其 提 取 出 来 虽 说 多 了 一 个 函 数 ， 但 是 代 码 更 加 清 晰 和 语 义 化 了 。 总 结 总 结 本 文 从 函 数 命 名 ， 函 数 参 数 和 函 数 的 代 码 编 写 三 个 方 面 谈 了 关 于 如 何 编 写 好 一 个 函 数 的 感 受 和 想 法 。 文 中 提 到 了 很 多 具 体 的 情 况 ， 当 然 日 常 编 码 中 肯 定 会 遇 到 更 多 复 杂 的 情 况 可 能 我 暂 时 没 有 想 到 。 我 简 单 的 归 纳 了 几 点 ： 1 .   准 确 地 对 变 量 、 函 数 命 名 2 .   不 要 有 重 复 逻 辑 的 代 码 3 .   函 数 的 行 数 不 要 超 过 2 0 行 ， 这 里 的 2 0 行 只 是 个 大 概 ， 并 不 一 定 是 这 个 数 字 4 .   减 少 嵌 套 我 相 信 大 家 一 定 会 很 多 关 于 这 方 面 的 经 验 ， 欢 迎 进 行 交 流 ， 共 同 提 高 代 码 质 量 。 转 载 自 ：   h t t p : / / l u o p q . c o m / 2 0 1 6 / 0 2 / 2 1 / w r i t e - g o o d - f u n c t i o n /   作 者 ：   狼 狼 的 蓝 胖 子 推 荐 文 章 推 荐 文 章 I D 点 击 标 题 或 输 入 文 章   I D   直 达 该 文 章 7 0 2 L i n u x   S h e l l 脚 本 面 试 2 5 问 1 0 2 0 千 奇 百 怪 的 程 序 员 们 1 1 0 0 为 什 么 一 些 古 老 的 编 程 语 言 不 会 消 亡 ？ 1 .   i f   ( a g e   >   1 8   & &   g e n d e r   = =   " m a n " )   { 2 .           / / d o S t h 3 .   } 1 .   v a r   c a n D o S t h   =   f u n c t i o n   ( a g e ,   g e n d e r ) { 2 .           r e t u r n   a g e   >   1 8   & &   g e n d e r   = =   " m a n " ; 3 .   } 4 .   . . . 5 .   . . . 6 .   . . . 7 .   i f ( c a n D o S t h ( a g e ,   g e n d e r ) ) { 8 .           / / d o S t h 9 .   }
回复

举报

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

本版积分规则

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

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