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


当前回答

前段时间我看到:

raise InvalidChild() # e.g. no legs

这很奇怪,因为“inwalida”在波兰语中是残疾人的意思。愚蠢的我:)

其他回答

/// <summary>
/// The possible outcomes of an update operation (save or delete)
/// </summary>
public enum UpdateResult
{

    /// <summary>
    /// Updated successfully
    /// </summary>
    Success = 0,

    /// <summary>
    /// Updated successfully
    /// </summary>
    Failed = 1
}

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

'CANNOT JUST QUIT!
/**
 * Always returns true.
 */
public boolean isAvailable() {
    return false;
}

永远不要依赖评论……

// GK Experimental

(GK是编码器的首字母缩写)

用来表示部分代码,实际上,是实验性的。:)

这是一个很好的标志,当你在调试过程中碰到它时,你可能会在接下来的几个小时里忙着修复黑客。;)

大概30页的xslt的中间部分

<!-- Here be dragons  -->