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


当前回答

我最近看到了这个:

//你刚刚输了比赛

如果你不知道游戏是什么: http://en.wikipedia.org/wiki/The_Game_ (mind_game) (这很傻,但在某种程度上很有趣)

其他回答

这一点对其他人来说很有趣,但对我来说就不那么有趣了。我从一个开发人员那里继承了代码(ASP),而他自己也继承了它。第一个程序员编写了一些很难理解的代码。第二个开发者添加了如下评论(为了保护不那么无辜的人,名字被隐藏了):

'This code was written by **************.
'I haven't a clue what it does. He hasn't a clue what it does.
'Nobody else has a clue what it does or how it does it.
'It is something to do with data but **** knows what.
'The ******* still works so please do not change this code,
'even though it is a complete pile of ****.

那我为什么不觉得有趣呢?嗯,这是一个客户内部网的ASP代码。

...正是那位顾客向我强调了这条评论。

:-(

public int hashCode() {
//sucks, but what're you gonna do

/*
int hash = 7;
for (int i = 0; i < array.length; i++)
    hash = hash * 31 * (null == array[i] ? 0 : array[i].hashCode());
return hash;
*/

return 0;
}

在一组相当长且复杂的while循环和if块的末尾,开发人员插入了最后的注释:

else
{
    // wobbly wilson said this would *never* happen!!
}

机智和讽刺的简洁混合:)

struct core_unlocker
{
    core_unlocker(lock)
    {
        m_lock = lock
        unlock(lock)  //Abandon All Locks, Ye Who Enter Core!
    }
    ~core_unlocker()
    {
        lock(m_lock)
    }  
    private:
    Corelock m_lock;
}
(A bunch of code that's really weird looking)  //Kludge.