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

当前回答

其中最经典的是皮埃尔·德·费马对他著名的“大定理”所作的评论:“这一页的空白处太小了，无法写下证明。”

350多年后才找到证据。

(根据维基百科，这是原文:)

Cubum autem在双cubos, aut 二元象限象限，和将军无限超quadratum中的一无所有在两种情况下我们是恶魔米拉比林健康。Hanc marginis exiguitas不是caperet。

.．.并翻译成英语:

(把立方体分开是不可能的化成两个立方，或者化成四次方 2 / 4次方，或者一般来说，任意幂大于二成二喜欢权力。我发现了一个真正的这是一个绝妙的证明边际太窄，无法容纳。)

其他回答

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

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

我记不清了，大概是这样的:

Person p = new Person("John", "Doe", "male");
Collection women = new ArrayList();
women.insert(p.getTail());

这是肮脏的代码;)

// fix for groupid > 9 
// if groupid ever gets to 100 everything will break (again)

if (groupid < 10) {
groupid = "0" + groupid;
}

// Caveat implementor

不是代码注释，而是SVN在同一个文件上提交注释:

第一次提交(在测试人员返回结果后，再进行数十次提交):

Squashed some IPR mod bugs. The were big and juicy ones, too.

2日提交:

Squashed some more mod bugs. Those are some nasty bugs, them mod bugs...

3rd:

Squashed some more mod bugs. They are like cockroaches: they'll live through a nuclear war.

4th:

Squashed some more John bugs. They too are like cockroaches: they appear anywhere John goes. Wait. That doesn't sound right.

Same John bug. It didn't die, just played 'possum.

是的，我厌倦了"修复bug"

推荐文章