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


当前回答

为什么你不应该将你的软件开发外包的一个经典案例:

public class Contact
{
    //...    

    /// <summary>
    /// Gets or sets the name of the first.
    /// </summary>
    /// <value>The name of the first.</value>
    public string FirstName
    {
        get { return _firstName; }
        set { _firstName = value; }
    }
}

其他回答

我最喜欢的评论是我的一个同性恋朋友说的。他喜欢用VB标记他所有的TODO注释。净,

'TODO: Matt Damon

有时会提供额外的信息,但通常不是这样。

private int mousycounter = 0; //Not really a counter
# Don use this. Never!

我的精选集:

// Thats the end of the While loop
// Clean up last row.  I really must program better than this.

// Note: You can't immediately tell if the line below works.

// Rounding - blech.  It's assumed that all .5s are rounded up.

// Sort out predictions first.  Seems like the right place for a prediction, 'first'.

// Let's interpret!

经典的旧netscape mozilla代码。我个人喜欢

就是不能乱来。而且移动记忆会毁了我们,还有 一切都太他妈难搞清楚了。所以,我放弃了,Mac 完全完全地吸走完整的岩石

但还有很多其他有趣的。