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


当前回答

public GetRandomNumber()
{
    // Chosen by a fairly rolen dice
    return 12;
}

其他回答

在SJ CA拍卖业务的早期,我曾与一个名叫Rick Dorin的人合作过。他写编译器的时候,你必须整天拨弄卡片。他的错误信息之一是

错误太多……让更少的!

生产源代码:

// Remove this if you wanna be fired

曾经有一个为我工作的程序员在他的代码中加入了“Style”注释,他在代码中编写了关于特定实现细节的内部争论,当他在某个特定的编码决策上被否决时,他就会离开。

例子:

的风格 '这是有争议的,但我传递图像句柄,而不是简单地 '传递缩放值,以保持调用代码更简单(通过a '一对声明语句)。或者,我可以传递这些数据 成员,但这将违反封装。

的风格 就像我在其他地方做过的一样,我将正式提出抗议 的表格),将注释序列化的实现视为 '一个属性,而不是一对Load/Save方法。这可能是 “风格的问题,值得商榷。

options.BatchSize = 300; //Madness? THIS IS SPARTA!

顶部的:靠近单位顶部的:

// Oh what a tangled web we weave
// When first we practice to deceive
// ASTA