搜索

[23389] 2014-12-17_让那些无用代码注释见鬼去

文档创建者：s7ckTeam
浏览次数：0
最后更新：2025-01-18
2014-12-17_让那些无用代码注释见鬼去 让 那 些 无 用 代 码 注 释 见 鬼 去 L i n u x 中 国   2 0 1 4 - 1 2 - 1 7 注 释 简 单 代 码 会 干 扰 对 重 要 注 释 的 理 解 。 程 序 开 发 者 最 好 能 用 最 精 要 的 注 释 来 解 释 重 点 代 码 。 注 释 简 单 代 码 会 干 扰 对 重 要 注 释 的 理 解 。 程 序 开 发 者 最 好 能 用 最 精 要 的 注 释 来 解 释 重 点 代 码 。 举 个 例 子 ， 你 打 开 一 个 电 箱 ， 里 面 有 几 百 根 电 线 ， 蒙 了 吧 。 再 一 看 ， 每 根 电 线 上 面 都 有 一 个 整 洁 的 小 标 签 。 真 是 谢 天 谢 地 啊 ！ 但 是 ， 当 你 一 个 个 去 翻 看 标 签 的 时 候 ， 见 鬼 的 ， 几 乎 所 有 的 标 签 都 是 空 白 的 ！ 然 后 ， 在 你 花 了 整 整 一 个 小 时 去 浏 览 每 一 个 小 标 签 之 后 ， 终 于 给 你 找 到 1 2 条 有 用 的 信 息 ， 真 心 喜 大 普 奔 ！ 当 然 ， 希 望 在 你 头 脑 一 片 混 乱 的 时 候 得 出 的 结 果 仍 然 是 正 确 的 ， 没 有 遗 漏 ， 呵 呵 呵 。 当 我 需 要 研 究 代 码 的 时 候 看 到 到 处 都 是 垃 圾 注 释 ， 唉 ， 我 的 感 觉 就 和 上 面 在 那 么 多 标 签 里 面 找 有 用 的 一 样 。 见 鬼 的 ， 想 从 一 大 堆 垃 圾 注 释 里 确 定 哪 个 有 用 简 直 就 像 大 海 捞 针 ！ 说 一 个 常 用 的 开 源 项 目 ， 里 面 都 是 这 些 垃 圾 注 释 ： 1 .   / * * 2 .   *   _ _ c o n s t r u c t   f u n c t i o n . 3 .   * 4 .   *   @ a c c e s s   p u b l i c 5 .   *   @ r e t u r n   v o i d 6 .   * / 7 .   p u b l i c   f u n c t i o n   _ _ c o n s t r u c t ( )   { 8 .     9 .   … 1 0 .   } 再 来 一 个 ：
原 文 ：   h t t p : / / b r a d t . c a / b l o g / u s e l e s s - c o d e - c o m m e n t s / 译 文 ：   h t t p : / / w w w . h t m l 5 t r i c k s . c o m / u s e l e s s - c o d e - c o m m e n t s . h t m l 1 .   / * * 2 .   *   C o n s t r u c t o r 3 .   * / 4 .   p u b l i c   f u n c t i o n   _ _ c o n s t r u c t ( )   { 5 .   … 6 .   } 还 有 一 个 ： 1 .   / /   C o n v e r t   f l o a t   t o   s t r i n g 2 .   $ v a l u e   =   f l o a t _ t o _ s t r i n g (   $ v a l u e   ) ; 这 些 注 释 就 跟 电 箱 里 的 空 白 标 签 一 样 ， 明 晃 晃 的 摆 在 那 里 ， 增 加 干 扰 还 降 低 注 释 的 可 用 性 。 看 到 这 样 的 注 释 ， 怪 不 得 那 些 可 怜 的 开 发 人 员 要 废 寝 忘 食 了 。 我 敢 肯 定 ， 那 个 把 空 白 标 签 贴 在 每 根 电 线 上 的 电 工 自 认 为 这 是 一 个 特 棒 的 主 意 ， 他 帮 助 了 那 些 在 他 后 面 来 的 人 ： 他 们 有 什 么 想 写 的 ， 只 要 在 这 些 已 经 贴 好 的 标 签 上 面 写 就 可 以 了 。 当 然 也 有 可 能 他 本 来 打 算 自 己 填 好 所 有 标 签 。 撇 开 他 的 好 意 不 说 ， 这 样 做 的 结 果 真 心 是 糟 透 了 ， 还 不 如 只 贴 那 有 用 的 1 2 张 呢 ！ 在 编 程 的 时 候 ， 开 发 人 员 经 常 被 告 知 要 注 释 ， 但 是 他 们 中 很 少 有 人 知 道 怎 样 注 释 才 好 。 所 以 开 发 人 员 注 释 代 码 的 时 候 ， 并 不 是 因 为 有 必 要 ， 而 是 因 为 他 们 觉 得 这 是 义 务 。 开 发 人 员 认 为 如 果 在 代 码 中 多 多 注 释 ， 能 表 现 他 们 工 作 能 力 。 见 鬼 的 ， 这 也 不 知 道 是 哪 门 子 的 理 论 。 我 最 厌 烦 每 隔 几 行 代 码 就 有 注 释 ， 而 实 际 上 却 屁 用 没 有 。 注 释 的 作 用 绝 对 不 是 为 了 纯 粹 炫 耀 我 们 是 “ 不 明 觉 厉 ” 的 程 序 员 ， 而 是 为 了 重 点 记 录 我 们 搞 这 些 代 码 的 原 因 。 这 样 一 来 ， 那 些 垃 圾 注 释 就 能 滚 蛋 了 。 看 下 面 的 例 子 : 1 .   / /   W e   n e e d   t o   a c c o u n t   f o r   p r o d u c t   p r i c e   c h a n g e s , 2 .   / /   s o   w e   g e t   t h e   p r i c e   o f   t h e   p r o d u c t   w h e n   e a c h   o r d e r   o c c u r r e d 3 .   $ o r d e r _ p r i c e s   =   $ t h i s - > g e t _ o r d e r _ p r i c e s ( ) ; 说 说 我 的 做 法 吧 ， 当 我 考 虑 是 否 要 写 注 释 的 时 候 ， 我 就 问 自 己 ： 如 果 以 后 回 过 头 来 看 这 些 代 码 ， 我 能 不 能 一 下 子 明 白 当 初 为 什 么 要 这 样 写 ？ 如 果 以 后 我 会 非 常 感 谢 这 些 注 释 ， 那 么 想 也 不 用 想 ， 果 断 写 上 注 释 。 否 则 ， 就 让 那 些 垃 圾 注 释 见 鬼 去 吧 。
阅 读 原 文
回复

举报

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

本版积分规则

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

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