你遇到过的源代码中最好的注释是什么?


当前回答

/*
This isn't the right way to deal with this, but today is my last day, Ron
just spilled coffee on my desk, and I'm hungry, so this will have to do...
*/

return 12; // 12 is my lucky number

其他回答

在一个生成HTML的旧perl脚本中找到:

# I would be _very_ brain farting if I said this code didn't need reviewing.
# It will make babies cry, and hair grow on your back, so please don't use it

我继承了一个没有任何UAT交付给客户的项目。它被踢出了栅栏,要求赔偿。

他们第一次使用它,它自然就爆炸了。它是一个插入库,可以覆盖任何以文件名而不是文件描述符作为参数的系统调用。

许多系统调用已经被遗忘。

当我开始使用这款游戏时,它的代码包含了以下内容:

/* core dumps around here but this is hardly ever called */

and

/* don't know why this works but it seeems to be ok */

哦,没有单元测试。一位同事已经开始添加缺失的系统调用和单元测试。

编写代码的那些混蛋还在团队中,他们根本不在乎已经交付的垃圾!

唐纳德·克努斯的另一个经典作品:

注意上面代码中的bug; 我只是证明了它是正确的,并没有尝试过。

// this is really complicated

没有其他评论了

// I know the line below is wrong, but it came that way from our IP vendor, and 
// the driver won't work if you "fix" it. I've had to revert this change 4 times
// now. Leave it alone, or I will hunt you down and hurt you
if (r = 0) {
    /* bunch of code here */
}
else
{
   /* even more code here */
}