最好的代码注释是什么样的?

下面是 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、

// 神奇。勿动。

你有没有遇到过更绝的?

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,966评论 25 709
  • (更多文章,可到微信公众号:bigdata321, 寻求报道转载,请加微信:didaomaster) 最近在 某Q...
    顶级程序员阅读 11,903评论 0 1
  • 前言 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定...
    VeC_House阅读 2,669评论 0 0
  • 和尚每日上山崖敲钟 行禅 诵经 坐禅 悟空 却从未想过真正的欲望是 那一阵阵藏在钟身内震荡过的风 ——《敲钟僧》
    段童阅读 2,790评论 0 0
  • 多少人曾梦想着能够从头来过,在他们快失去一切时将生活归零。 ——马克·李维《如果一切重来》 就在刚刚,我吃完中饭开...
    YFLX阅读 3,483评论 2 4

友情链接更多精彩内容