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

A:很简单——就是那个帮我解决了我当时遇到的任何问题的人，而且有很多这样的人!

其次是那些帮助指导新开发避免已知陷阱的方法。

写得很好的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日志更早)最终追踪到的错误。

在一些非常蹩脚的vb代码(我知道这都是蹩脚的，但)，我发现这是一个空的if控制块中的注释，它说:

If bFound Then
     'I love it when I write kick ass code like this
Else
  .
  .

//The following 1056 lines of code in this next method 
//is a line by line port from VB.NET to C#.
//I ported this code but did not write the original code.
//It remains to me a mystery as to what
//the business logic is trying to accomplish here other than to serve as
//some sort of a compensation shell game invented by a den of thieves.
//Oh well, everyone wants this stuff to work the same as before.
//I guess the devil you know is better than the devil you don't.

多年前，我遇到了这样一个问题:

/***************************************************************************/
/*  deep wizardry. do not touch.                                           */
/*                                                                         */
/*  no seriously.  XXXXXX I'm looking at you. If you screw with this again */
/*  I will kill you with my swingline stapler.                             */
/*                                                                         */
/* ...                                                                     */

然后描述了一个特别复杂的算法。

这比你在许多评论标题中看到的可怕的法律通知和免责声明要好得多。从SQLite。

/*
** The author disclaims copyright to this source code.  In place of
** a legal notice, here is a blessing:
**
**    May you do good and not evil.
**    May you find forgiveness for yourself and forgive others.
**    May you share freely, never taking more than you give.
*/