C#代碼注釋規範 .NET產生API文檔

1、檔案頭部注釋

    ///     /// 作者：Crayon    /// 創始時間：2013-08-20    /// 修改人：蔔娜娜    /// 修改時間：2013-08-20    /// 修改人：NANA    /// 修改時間：2013-08-21    /// 描述：    ///     主要用於產品資訊的資料錄入，…     /// 

模組注釋：

//////模組編號：<模組編號，可以引用系統設計中的模組編號>///作用：<對此類的描述，可以引用系統設計中的描述>///作者：作者中文名///編寫日期：<模組建立日期，格式：YYYY-MM-DD>///

如果模組有修改，則每次修改必須添加以下注釋：

//////Log編號：< SPAN>編號,從1開始一次增加>///修改描述：<對此修改的描述>///作者：修改者中文名///修改日期：<模組修改日期，格式：YYYY-MM-DD>///

2、類屬性注釋

/// /// 屬性說明/// 

3、方法注釋

/// <summary>/// 方法說明/// </summary>

4、代碼間注釋

代碼間注釋分為單行注釋和多行注釋：

單行注釋：

//<單行注釋>

多行注釋：

/*多行注釋1多行注釋2多行注釋3*/

代碼中遇到語句塊時必須添加註釋（if,for,foreach,……）,添加的注釋必須能夠說明此語句塊的作用和實現手段（所用演算法等等）。

塊注釋時，應該採用以下風格：

/* Line 1  * Line 2  * Line 3  */ 

/// 表示XML注釋
為了方便產生API文檔，XML規範必須規範。

.NET產生API文檔 （轉載）

http://blog.csdn.net/chtnj/article/details/8278342
http://blog.csdn.net/chtnj/article/details/8278360