你遇到过的源代码中最好的注释是什么?
当前回答
这是众所周知的，但我喜欢它(在sys/ufs/ufs_vnops.c中):
/*
* A virgin directory (no blushing please).
*/
在FreeBSD内核源代码树中(甚至在之前，回到4.xBSD)
其他回答
有一次，我问一个同事如何用我们的内部框架做一些事情(忘了具体是什么，一些晦涩的技术调用)。 他说“简单，看这里”，然后在他的编辑器中打开一个。java文件，在几页代码中间给我看了这个注释:
// HERE
我刚刚检查了一下，注释仍然在这个文件中:)
//When I wrote this, only God and I understood what I was doing
//Now, God only knows
catch (Ex as Exception)
{
// oh crap, we should do something.
}
没有什么比一个空的catch块更能让人觉得代码是健壮的....
从Joomla !来源:
// this is daggy??
今天刚加了这个:
// Hardcoded this for time sake ... will make andrew fix later :)
