你遇到过的源代码中最好的注释是什么?
当前回答
在JUnit API中找到:
/**
* ...as the moon sets over the early morning Merlin, Oregon
* mountains, our intrepid adventurers type...
*/
public Test createTest(Class theClass, String name) {
...
}
其他回答
生产源代码:
// Remove this if you wanna be fired
我个人最喜欢的是打油诗形式的文档:
Subclassing made Zope and TR
much harder to work with by far.
So before you inherit,
be sure to declare it
Adapter, not PyObject*
这可能会破坏这个笑话,但由于它有点晦涩,我将解释:
这里的TR指的是“扭曲的现实”。Zope 2和最初的扭曲。Reality包大量而不幸地使用了多重继承,这可能会使您在看到方法调用时难以理解发生了什么。Zope 3,扭曲自己,扭曲。现实的后继者(包括最近的假想)通常更倾向于组件组合。
我最喜欢的评论是我的一个同性恋朋友说的。他喜欢用VB标记他所有的TODO注释。净,
'TODO: Matt Damon
有时会提供额外的信息,但通常不是这样。
这在我自己的代码中出现过几次。显然我摸了不止一次。
// TODO: Fix this. Fix what?
// This interface defines method signatures<br>
interface IWhatever { ... }