10个最“优秀”的代码注释

下面是stackoverflow网站上网友针对你看到过的最好的代码注释是什么样的?这个问题给出的回答的前10条:

  1. // 亲爱的维护者:
    // 如果你尝试了对这段程序进行‘优化’,
    // 并认识到这种企图是大错特错,请增加
    // 下面这个计数器的个数,用来对后来人进行警告:
    // 浪费在这里的总时间 = 39h
  2. /** * 致终于来到这里的勇敢的人:
        你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改
    我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,
    我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。
    永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */
  3. Exception up = new Exception("Something is really wrong."); throw up; 
  4. // 一些修改1 - 2002/6/7 增加临时的跟踪登录界面
    // 一些修改2 - 2007/5/22 我临时的犯傻
  5. #define TRUE FALSE //逗一逗调试程序的傻瓜们
  6. if (/*you*/ $_GET['action']) { //celebrate(恭喜)
  7. // 如果这段代码好用,那它是Paul DiLascia写的。
    //如果不好用,我不知道是谁写的。
  8. //写这段代码的时候,只有上帝和我知道它是干嘛的
    //现在,只有上帝知道
  9. // 晕了,以后再修改
  10. // 神奇。勿动。

你有没有更绝的?

分享这篇文章:

67 Responses to 10个最“优秀”的代码注释

  1. Rache says:

    我发现我写的代码注释和第四个有点像……糟了

  2. mz says:

    囧啊,我的代码里都是FIXME居多

  3. Vi says:

    最后一个应该是”魔法。勿动。”吧

  4. LiaWind says:

    原贴被删了?

  5. kaixuan1901 says:

    第五条太坑爹了吧!

  6. evan says:

    看这种注释就是浪费时间啦。

  7. vincent says:

    /*有问题去找需求方 他们让这样搞的 – vincent 2011-9-21*/

  8. BLAN says:

    /*如果你能弄清楚这一段,求求你务必发邮件至aaa@bbb.com告诉我,不胜感激*/

  9. 贾珣 says:

    /* Write once debug every的精髓之所在 */

  10. suigara says:

    // 这个不知道是谁写的 看起来没用,但我不敢删

  11. leizisdu says:

    // 勇士,乐观的接收这个现实吧!leizisdu, 2011-11-23

  12. 白头发乌鸦 says:

    前来观望的第四类~~~

  13. darkerray says:

    // For test—————————May be
    我看到这段注释的时候确实有种想吐血的冲动。。。

  14. zha0lp says:

    // 2011-12-21 虽然我也不想这样做,但是有个讨厌的家伙就要我这样做,迟早会证明,他是错的。

  15. frankyao says:

    ################
    # DEBUG
    ################

  16. 做做 says:

    /*
    *2012-01-05 19:39:24
    */

  17. www says:

    坑爹的注释

  18. la.onger says:

    //下n行代码,下个月重构

  19. 刘栋 says:

    //元芳你怎么看?

  20. xesam says:

    //就他妈这样了吧

  21. 喔喔兒 says:

    = =我见过最后那个…

  22. 青青qing青 says:

    // todo xxx

  23. a525398535 says:

    /**
    *如果你发现了这里有一些bug,那么恭喜你发现了我在2011-07-06时发现的问题
    **/

  24. 老杨 says:

    注释很有意思

  25. flor says:

    注释不错,准备放到code中

  26. 78oa.com says:

    很不错的注释哟

  27. 三爪猫 says:

    其实第三条的注释是

    Exception up = new Exception(“Something is really wrong.”);
    throw up; //ha ha

    哈哈

  28. Mr.7 says:

    return 1; //返回 1

  29. test says:

    /**
    * 这个方法是我写的,。。。。。。。。。
    */

  30. pmst says:

    /*
    你懂的!
    */

  31. none says:

    这翻译实在不怎么好,很多原来英文的意味没表达出来,特别是第四条直接翻译错误。
    第四条的正确翻译应该是:

    // 一些修改1 – 2002/6/7 在登录界面临时增加的一些追踪代码
    // 一些修改2 – 2007/5/22 临时你妹啊!

    (意思是过了5年这些所谓“临时”代码还没有被去掉直到第二条注释的作者发现它)

  32. mrzero says:

    # 这个前端真是¥%%*(……%@

  33. Ornithopter says:

    throw new Exception(“It’s not your fault.”);
    这是我最喜欢的异常了

  34. 张剑 对这篇文章的反应是不明觉厉
  35. jason lee 对这篇文章的反应是不明觉厉
  36. Spot 对这篇文章的反应是赞一个
  37. 空灵游侠 对这篇文章的反应是俺的神呀
  38. 卢显洲 says:

    修改别人的代码,修改自己未加注释的,自以为很简单的老代码,都是非常让人头痛的。

  39. ubuntuvim 对这篇文章的反应是俺的神呀
  40. 斯文冠希 says:

    8、9躺枪的自觉加一~

  41. alex says:

    看到最后我笑了,都能想想的到当时的场景

  42. jiahongfen 对这篇文章的反应是
  43. steve zhang  这篇文章
  44. shangfei987@126.com  这篇文章
  45. 张渊博 对这篇文章的反应是
  46. 寻路人  这篇文章
  47. wwah 对这篇文章的反应是赞一个
  48. mrChen 对这篇文章的反应是赞一个
  49. 张增天 对这篇文章的反应是俺的神呀
  50. 夹克牛 对这篇文章的反应是赞一个
  51. Frank_Han 对这篇文章的反应是俺的神呀
  52. 王雨情  这篇文章
  53. wumouse  这篇文章
  54. summervillejia  这篇文章, 并对这篇文章的反应是俺的神呀
  55. alice says:

    其实感觉最坑爹的注释是没有注释

  56. takemegod says:

    我看过的注释里面直接写PM一点儿不懂技术,把构造改了又改

    后期还写到这个代码的复杂性正在以光速的方向里你的神经网络分离。

    还有写到我不会写我的邮箱在这代码里面,因为我可以肯定告诉你,这代码离开

    我后,维护的时候别找我。估计我比现在啃代码的你还了解的不多。

    这代码来自于一个奇葩的项目。

  57. akka says:

    // 项目经理让这里运行缓慢一些,以后好让客户优化加钱
    sleep(5000);

发表评论

电子邮件地址不会被公开。 必填项已用*标注

壹加壹等于