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


当前回答

从技术上讲,这不是一个评论,而是在凌晨2点左右编写的代码:

consent = False

... 该变量永远不会再次使用,并且出现在套接字的监听循环的开始。

其他回答

我刚刚在一些遗留代码中发现了这个..

'CANNOT JUST QUIT!
// TODO: what the hell is this all about?

然后一些代码被注释掉了。

这是在今天早些时候的工作代码中发现的。我不知道我该笑还是该哭……

/**
 * Hexadecimal digit
 */
protected $version = -1;
// if the resultMap size is less than or equal to zero
// then the product is added
if (resultMap.size() <= 0)

写得很好的Lisp是最容易阅读的语言之一,我喜欢它。但是写得不好的Lisp可能是比糟糕的Java更糟糕的噩梦,等等。

在这里,我们需要创建一个“组文件”,如果一个原始文件有3个变体,后缀为a, b和c。我一直试图追踪一个奇怪的错误,我们得到了不必要的组文件……

  (let ((varianta (format nil "~aa" problem))
        (variantb (format nil "~ab" problem))
        (variantc (format nil "~ac" problem)))
    ;;if the A and B variants exist, create a group file
    ;;(why not just check for a? I don't know, this just feels right)
    (when (and (probe-file varianta)
               (probe-file variantb))
      ...)))

Bug: 1, Gut: 0。

显然,写这篇文章的人没有想到,也许检查所有三种变体是一个好主意。当然,这是我在最初编写这段代码十年之后(它比第一个SVN日志更早)最终追踪到的错误。