搜索

[24351] 2015-10-04_编码之道：取个好名字很重要

文档创建者：s7ckTeam
浏览次数：2
最后更新：2025-01-18
2015-10-04_编码之道：取个好名字很重要 编 码 之 道 ： 取 个 好 名 字 很 重 要 L i n u x 中 国   2 0 1 5 - 1 0 - 0 4 代 码 就 是 程 序 员 的 孩 子 ， 给 “ 孩 子 ” 取 个 好 听 的 名 字 很 重 要 ！ 我 们 在 项 目 开 发 中 ， 接 触 到 的 变 量 、 函 数 、 类 多 数 都 是 项 目 自 己 定 义 的 ， 往 往 都 是 为 了 解 决 一 些 特 定 的 领 域 的 问 题 ， 引 入 了 各 种 各 样 的 概 念 ， 代 码 里 面 的 名 字 就 对 应 着 问 题 领 域 或 方 案 领 域 的 这 些 概 念 ， 所 以 ， 对 于 一 个 命 名 良 好 ， 代 码 规 范 ， 设 计 简 洁 的 系 统 ， 要 想 非 常 快 的 理 解 一 个 系 统 ， 最 直 接 的 方 式 就 是 R T F C ( R e a d   T h e   F u c k i n g   C o d e ) 。 对 于 一 个 不 断 演 进 的 系 统 ， 代 码 的 可 读 性 至 关 重 要 ， 首 要 要 解 决 的 问 题 就 是 名 字 ， 变 量 名 、 函 数 名 、 类 名 等 都 需 要 仔 细 斟 酌 ， 认 真 对 待 ， 一 个 能 够 简 洁 ， 能 够 清 晰 表 达 概 念 和 意 图 的 名 字 就 显 得 尤 为 重 要 。 阅 读 《 代 码 整 洁 之 道 》 这 本 书 后 发 现 其 中 说 的 内 容 在 我 们 自 己 项 目 中 比 比 皆 是 ， 随 便 拿 出 一 块 代 码 都 可 以 当 做 反 面 教 材 给 大 家 讲 半 天 。 长 时 间 积 累 ， 导 致 代 码 发 霉 变 质 ， 取 名 也 是 毫 无 章 法 ， 信 手 拈 来 。 阅 读 这 样 的 代 码 ， 撞 南 墙 的 心 都 有 了 。 下 面 结 合 自 己 项 目 中 的 问 题 和 《 代 码 整 洁 之 道 》 谈 谈 关 于 命 名 相 关 的 原 则 。 1 .   原 则 ： 名 副 其 实 选 名 字 是 件 严 肃 的 事 情 ， 选 个 好 名 字 很 重 要 。 如 果 名 字 需 要 注 释 来 补 充 ， 那 就 不 是 个 好 名 字 。 最 重 要 的 是 要 名 副 其 实 ， 名 字 能 表 达 出 概 念 和 意 图 。 B A D : 1 .   i n t   t   =   c u r r e n t T i m e . e l a p s e ( e ) ;   / /   消 逝 的 时 间 ， 以 毫 秒 计 2 .   . . . 3 .   i f   ( t   >   t i m e o u t _ v a l u e )
G O O D : 2 .   原 则 ： 避 免 误 导 必 须 避 免 留 下 掩 藏 代 码 本 意 的 错 误 线 索 避 免 使 用 与 本 意 相 悖 的 词 提 防 使 用 不 同 之 处 较 小 的 名 称 拼 写 前 后 不 一 致 就 是 误 导 B A D : 2 .   3 .   原 则 : 做 有 意 义 的 区 分 代 码 是 写 给 人 看 的 ， 仅 仅 是 满 足 编 译 器 的 要 求 ， 就 会 引 起 混 乱 以 数 字 系 列 命 名 ( a 1 ， a 2 ， . . . ) ， 纯 属 误 导 无 意 义 的 废 话 :   a ，   a n ，   t h e ，   I n f o ，   D a t a B A D : 3 .   i f   ( t   >   t i m e o u t _ v a l u e ) 4 .   { 5 .         Z e b r a : : l o g g e r - > d e b u g ( " - - - 一 次 循 环 用 时   % u   毫 秒 - - - - - " ,   t ) ; 6 .   } 1 .   i n t   e l a p s e d _ m s   =   c u r r e n t T i m e . e l a p s e ( e ) ; 2 .   . . . 3 .   i f   ( e l a p s e d _ m s   >   t i m e o u t _ v a l u e ) 4 .   { 5 .         Z e b r a : : l o g g e r - > d e b u g ( " - - - - - 一 次 循 环 用 时   % u   毫 秒 - - - " ,   e l a p s e d _ m s ) ; 6 .   } 1 .   s t d : : v e c t o r < i n t >   a c c o u n t _ l i s t ;   / /   _ l i s t 就 是 一 个 误 导 ，   a c c o u n t s 会 更 好 3 .   b o o l   s e n d T o Z o n e S e r v e r ( ) ;   / /   和 下 面 的 函 数 差 别 很 小 4 .   b o o l   s e n d T o Z o n e S e r v e r s ( ) ;   / /   s e n d T o A l l Z o n e S e r v e r s 会 好 点 1 .   v o i d   c o p y ( c h a r   a 1 [ ] ,   c h a r   a 2 [ ] )   { 2 .       f o r   ( s i z e _ t   i   =   0 ;   a 1 [ i ]   ! =   ' 0 ' ;   i + + ) 3 .             a 2 [ i ]   =   a 1 [ i ] ;
G O O D : 4 .   原 则 : 使 用 可 读 的 名 字 避 免 过 度 使 用 缩 写 可 读 的 名 字 交 流 方 便 猜 一 猜 下 面 的 类 是 干 什 么 的 ？ 和 别 人 怎 么 说 这 几 个 类 ？ 根 据 这 些 简 直 变 态 的 缩 写 ， 如 果 没 有 注 释 基 本 上 很 难 知 道 是 干 什 么 的 ， 当 你 和 别 人 交 流 的 时 候 ， 你 就 不 得 不 一 个 一 个 字 母 来 念 “ X - L - Q - Y ” 、 “ L - T - Q   M a n a g e r ” ， 鬼 知 道 你 说 的 是 什 么 ？ P S .   X L Q Y - X i a n L v Q i Y u a n （ 仙 履 奇 缘 ） ，   L T Q - L i a o T i a n Q u n （ 聊 天 群 ） ， 有 这 样 的 名 字 也 是 醉 了 。 B A D : 5 .   原 则 : 使 用 可 搜 索 的 名 字 避 免 使 用 M a g i c   N u m b e r 避 免 使 用 单 字 母 ， 或 出 现 频 率 极 高 的 短 字 母 组 合 ( 注 意 度 的 把 握 ) B A D : 5 .   3 .             a 2 [ i ]   =   a 1 [ i ] ; 4 .   } 1 .   v o i d   c o p y ( c h a r   s o u r c e [ ] ,   c h a r   d e s t [ ] )   { 2 .       f o r   ( s i z e _ t   i   =   0 ;   s o u r c e [ i ]   ! =   ' 0 ' ;   i + + ) 3 .             d e s t [ i ]   =   s o u r c e [ i ] ; 4 .   } 1 .   c l a s s   X L Q Y ; 2 .   c l a s s   F C N V ; 3 .   c l a s s   L T Q M a n a g e r ; 1 .   i f   ( o b j - > b a s e - > i d   = =   4 6 6 1 )   / /   4 6 6 1 是 啥 玩 意 ? 2 .   { 3 .         u s e t y p e   =   C m d : : X X X X X X X ; 4 .   } 6 .   i n t   e ;   / /   怎 么 查 找 ?
G O O D : 2 .   6 .   原 则 : 避 免 使 用 编 码 匈 牙 利 标 记 法 ： W i n d o w s   A P I 时 代 留 下 的 玩 意 形 如 ： 类 型 变 换 导 致 名 不 副 实 ， 就 有 可 能 出 现 明 明 是 个 ， 变 量 名 却 是 。 P S . 匈 牙 利 命 名 对 于 我 们 这 些 在 L i n u x 下 摸 爬 滚 打 的 好 多 年 的 来 说 ， 看 着 真 心 别 扭 。 成 员 前 缀 ： 形 如 ： 基 本 上 都 无 视 ， 为 何 要 多 次 一 举 P S . 说 到 这 一 点 ， 可 能 有 些 同 学 有 不 同 意 见 了 ， “ 我 这 样 写 是 为 了 区 分 成 员 变 量 和 临 时 变 量 啊 ！ ” ， 好 像 这 样 写 也 没 什 么 大 不 了 ， 遵 循 代 码 规 范 即 可 。 如 G o o g l e 的 C + + 代 码 规 范 ， 私 有 变 量 形 如 ： ， 加 后 缀 ， 其 目 的 除 了 让 你 知 道 这 货 是 个 私 有 变 量 ， 还 有 一 点 就 是 防 止 有 些 人 图 省 事 把 带 私 有 变 量 直 接 p u b l i c 掉 ， 因 为 谁 也 不 喜 欢 在 代 码 里 面 看 到 大 量 这 些 带 把 的 玩 意 。 接 口 和 实 现 ： 接 口 名 形 如 ： I X X X ，   I - 接 口 修 饰 前 缀 类 名 形 如 ： C X X X ，   C - 类 修 饰 前 缀 这 些 修 饰 多 数 时 候 都 是 废 话 7 .   X X X X : i t e r a t o r   i t ;   / /   变 量 作 用 的 范 围 比 较 大 的 时 候 ， 也 不 见 得 是 个 好 名 字 1 .   # d e f i n e   O J B E C T _ F E E D B A C K _ C A R D   4 6 6 1 3 .   i f   ( O J B E C T _ F E E D B A C K _ C A R D   = =   o b j - > b a s e - > i d ) 4 .   { 5 .         u s e t y p e   =   C m d : : X X X X X X X ; 6 .   } w d X X ，   d w X X X ，   s t r X X X D W O R D q w N u m m _ n a m e ，   m _ x x x x x x _ _
7 .   原 则 : 名 字 尽 量 来 自 解 决 方 案 领 域 或 问 题 领 域 使 用 解 决 方 案 领 域 名 称 ： 写 代 码 的 同 学 多 数 都 是 都 出 自 C S ， 术 语 、 算 法 名 、 模 式 名 、 数 学 术 语 尽 管 用 。 如 A c c o u n t V i s i t o r ： V i s i t o r 模 式 实 现 的 A c c o u n t 类 。 使 用 问 题 领 域 的 名 称 我 们 代 码 里 面 多 数 都 是 这 些 名 称 ， 不 明 白 找 策 划 问 问 ， 基 本 上 都 是 功 能 相 关 的 名 称 。 8 .   原 则 : 适 当 使 用 有 意 义 的 语 境 良 好 命 名 的 类 、 函 数 、 名 称 空 间 来 放 置 名 称 ， 给 读 者 提 供 语 境 只 有 两 三 个 变 量 ， 给 名 称 前 加 前 缀 事 不 过 三 ， 变 量 超 过 三 个 考 虑 封 装 成 概 念 ， 添 加 s t r u c t 或 c l a s s B A D : 最 后 ： 我 们 的 C + + 命 名 规 范 文 件 名 ： 首 字 母 大 写 ， 多 个 词 组 合 起 来 如 : 类 名 / 名 称 空 间 名 ： 首 字 母 大 写 ， 多 个 词 组 合 起 来 使 用 名 词 或 名 词 词 组 避 免 使 用 C 前 缀 ， 如 : 如 : 函 数 名 ： 首 字 母 小 写 使 用 动 词 或 动 词 词 组 避 免 使 用 孤 立 的 全 局 函 数 ， 可 以 封 装 在 类 或 名 称 空 间 里 面 g e t ，   s e t ，   i s 前 缀 的 使 用 如 : 1 .   / /   看 着 整 齐 ? 使 用 方 便 ? 2 .   D W O R D   l o v e _ e n s u r e _ t y p e _ ;     / / 当 前 的 爱 情 保 险 类 型 3 .   D W O R D   l o v e _ e n s u r e _ r e t _ ;   / / 购 买 爱 情 保 险 回 应 标 示 4 .   D W O R D   l o v e _ e n s u r e _ t o t a l _ ;   / / 现 在 已 经 盖 章 数 目 5 .   D W O R D   l o v e _ e n s u r e _ . . . _ ;     / / . . . 6 .   D W O R D   l o v e _ e n s u r e _ . . . _ ;     / / . . . S c e n e U s e r . h   S e p t . h C S e p t S c e n e U s e r   S e p t W a r f u c k Y o u ( )
原 文 ： h t t p : / / g a m e - l a b . o r g / p o s t s / z o c - c l e a n c o d e - 2 / 作 者 ：   d a v i d + + ， 变 量 名 ： 全 部 字 母 小 写 ， 多 个 词 以 下 划 线 分 隔 私 有 成 员 变 量 加 后 缀 ， 公 有 变 量 不 用 避 免 使 用 孤 立 的 全 局 变 量 ， 可 以 封 装 在 类 或 名 称 空 间 里 面 如 : ， 取 名 是 一 件 严 肃 的 事 情 ， 我 们 需 要 认 真 对 待 ， 名 字 代 表 着 一 个 个 概 念 ， 名 字 代 表 着 你 想 表 达 的 意 图 ， 好 名 字 是 可 读 代 码 的 首 要 条 件 ： 写 下 任 何 一 行 代 码 的 时 候 ， 心 里 都 要 想 着 自 己 的 代 码 是 给 别 人 看 的 。 为 函 数 、 变 量 、 类 取 个 好 名 字 ， 遵 循 规 范 和 原 则 。 见 到 不 符 合 规 范 和 原 则 的 名 字 ， 确 毫 不 留 情 的 干 掉 它 ， 特 别 是 功 能 性 的 代 码 。 l e v e l u p ( ) _ q u e s t _ i d q u e s t i d _
阅 读 原 文
回复

举报

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

本版积分规则

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

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