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


当前回答

if(m_measures =/*=*/ --index)
{
    ....

其他回答

以下注释来自我必须调试的一个旧项目:

//Haleluya i can go home!
//this is a crap way to do this but I ran out of patience

DelButton.click(); 

在一个名为“Bar”的类中(这是一个不具有描述性名称的UI控件),类头文件:

/// <summary>I pity the "foo".</summary>

Remove()方法:

/// <summary>A "foo" and his money are soon parted.</summary>

更糟糕的是,业务合作伙伴从生成的文档中指出了这一点。更糟糕的是,这些可能是我们从那家伙那里得到的最接近有用文件的东西。

这个我在Python 2.5的“twisted”包中找到的(文件是tcp.py在第371行)

# Limit length of buffer to try to send, because some OSes are too
# stupid to do so themselves (ahem windows)
return self.socket.send(buffer(data, 0, self.SEND_LIMIT))
return 1; # returns 1