你遇到过的源代码中最好的注释是什么?
当前回答
最近在我们的代码中发现了这一点(我们开发企业软件):
// Instance of excel
Excel excel = this.CreateExcelInstance();
excel.Open(stream); // how to close it?!
在此之前，我确信我们已经摆脱了这些“有趣的东西”，我们正在以正确的、意识形态正确的方式做这件事……
其他回答
这是众所周知的，但我喜欢它(在sys/ufs/ufs_vnops.c中):
/*
* A virgin directory (no blushing please).
*/
在FreeBSD内核源代码树中(甚至在之前，回到4.xBSD)
// this comment included for the benefit of anyone grepping for swearwords: shit.
对上帝诚实:
// This is crap code but it's 3 a.m. and I need to get this working.
在某些汇编程序中，在包含&h723的行末尾
' RIP LVB
(明白吗?)
// If this comment is removed the program will blow up
