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

当前回答

// I love the smell of dirty XML in the morning
xml = xml.Replace("xmlns=\"urn:bsd.orion/inventory\"", "");

其他回答

在一个项目中，我们有一个依赖ppwlib，当时它的FreeBSD端口有点糟糕，所以我不得不从源代码手动构建它。但它并没有立即起作用，我不得不研究代码;有一些复杂的类层次结构，部分代码是由宏生成的，其父类声明以它们开始

// The root of all evil ... umm classes

// TODO: not this

上面写了一个同事迫切需要优化的查询。替他说句话，当时我们几个月都是每周工作70个小时……

我刚刚完成了一个日志框架(使用Trace，为什么没有这样的存在我不知道)。我做了一个继承自TraceListener的方便基类。它覆盖了所有的TraceListener方法，并将它们路由到一个方法中——因此有很多文档注释:

// TODO: Need some codemonkey to doc comment this class.

BerkeleyDB

/*
 * Chaos reigns within.
 * Reflect, repent, and reboot.
 * Order shall return.
 */
return (DB_RUNRECOVERY);

//Please comment on your source code

推荐文章