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


当前回答

// woot, global var. I havent done this for a long time.

其他回答

这似乎阻止了白痴搞砸我的代码…

// Autogenerated, do not edit. All changes will be undone.
/// <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
}

在一个著名的商业DOS电子表格应用程序中:

/* This comment was just added in order to check-in a file that was last 
checked in by [Insert Programmer FirstName] "Back-to-the-Future" [Insert 
Programmer LastName]. While testing for year 2000 problems, he accidentally 
checked-in this file while his machine clock was set forward to the year 2000. 
This meant that the source code was always newer than the object file and 
compiled every time the code was built. I'm checking this file in again to 
fix that. */

用于政府目的的企业等级系统中的评论

'RH 5/24/06 burn me if this dosn't work.. :)

好RH.....公司总裁/首席开发人员

// Catching exceptions is for communists

来自Mike Duncan在SQLite上的页面。