你遇到过的源代码中最好的注释是什么?
当前回答
#define SHIT_HAPPENED (BASE + 1) /* generic shit happened */
其他回答
# To understand recursion, see the bottom of this file
在文件的底部:
# To understand recursion, see the top of this file
-- Comment this later
这是一个4000多行的PL/SQL过程的第2行。唯一的评论。手术已经进行了4年了,后来还是没来…
// haack, phil haack
and:
/* hack, hack, hack, hack, hack hack, hack, hack
* hackity hack, oh wonderful hacks
* wonderful hacks, oh wonderful hack, hack, hack
* hack hack hack... and spam
*/
编辑:刚刚在我的一些代码中发现了这个(项目希望保持匿名):
// yikes, we need to:
/*
* o
* -|- < US CROSSING PLATFORM
* |\
************************************************
* | ^ PLATFORM |
* | T |
* | TROLL^ |
*/
// right now:
/*
* o ./_ |
* -|-[]\ | (_'_) () (\) | ) \|/ (S) < WALL
* |\ | ^ FRIENDLY MESSAGE FROM YOUR FRIENDS AT MICROSOFT
* ***********************************************
* | ^PLATFORM |
* ^ SPRAY CAN (IN HAND)
*/
public static class DefaultFonts
{
public static string SansSerifPath
{
get { return @"C:\Windows\Fonts\arial.ttf"; }
}
public static string SerifPath
{
get { return @"C:\Windows\Fonts\times.ttf"; }
}
public static string MonospacePath
{
get { return @"C:\Windows\Fonts\courier.ttf"; }
}
}
我好喜欢双关语。
我刚刚完成了一个日志框架(使用Trace,为什么没有这样的存在我不知道)。我做了一个继承自TraceListener的方便基类。它覆盖了所有的TraceListener方法,并将它们路由到一个方法中——因此有很多文档注释:
// TODO: Need some codemonkey to doc comment this class.
// Caveat implementor