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


当前回答

我相信在JBoss的某个地方有一行写着

return null; //Not really null

我一直很喜欢这句话。

其他回答

/*
    FIXME:  why the fuck did anyone ever think this kind of expensive iteration
                    was a good idea?

几年前,我在一个没有单元测试可言的大型代码库中工作。

代码中隐藏了一个执行一些日历计算的方法。它有点坏了,由于一些不幸的情况,不得不以一种非常笨拙的方式处理夏令时。

我们不得不修了几次,每一次,我们都会在几个月后发现一些东西坏了。

在花了一整天的时间修复和分析之后,我把代码放到了源代码控制中,并附上了这样的评论:

// this code was written after a version trying to do {this} failed because of {reason},
// previously we were doing {this} which failed because of {reason}. This is 
// now written {this} way so that {lots of reasons here}. If you want to touch
// this code, please make sure that it produces the right answers when tested with:
//
// {some sort of unit test}

最终,我的团队被外包了。有时我想知道这段代码发生了什么:)

在游戏中,这个物体可以被踩到,或者:

stepOff(); //bitch
// I love the smell of dirty XML in the morning
xml = xml.Replace("xmlns=\"urn:bsd.orion/inventory\"", "");
//The following code is commented out
//(a load of commented out code followed)