c# 利用注釋summary生成文檔

注釋寫法

/// <summary>/// 按頁面分類取輪播列表;/// result List-DtoBanner;/// not require login;/// </summary>/// <param name="call">接口響應(yīng)</param>/// <param name="parentId">父id</param>/// <returns>DtoBanner</returns>/// <remarks> /// DtoBanner see <see cref="Lb.Model.Dto.DtoBanner"/>/// </remarks>public static DtoBanner ListByType(AppCall call, int parentId){	// code remove	return null;}
以下是一個msdn上的例子：
/// <summary>        /// This sample shows how to specify the <see cref="TestClass(int)"/> constructor as a cref attribute.        /// </summary>        public TestClass(int value)        { }        /// <summary>        /// The GetZero method.        /// </summary>        /// <example>         /// This sample shows how to call the <see cref="GetZero"/> method.        /// <code>        /// class TestClass         /// {        ///     static int Main()         ///     {        ///         return GetZero();        ///     }        /// }        /// </code>        /// </example>        public static int GetZero()        {            return 0;        }
說明：
summary 部分是對方法或類的說明，一般只有public,PRotected類型的方法才有必要加; <summary> 標(biāo)記的文本是唯一有關(guān) IntelliSense 中的類型的信息源，它也顯示在 Object Browser Window 中，使用 /doc 進行編譯可以將文檔注釋處理到文件中。 若要基于編譯器生成的文件創(chuàng)建最終文檔，可以創(chuàng)建一個自定義工具，也可以使用 Sandcastle等工具。
param 是參數(shù)部分returns 是返回值，沒有返回值的沒有這個remarks 一般是附加說明，自成生成的結(jié)構(gòu)里沒有，可以手動加在后面，
see cref 相當(dāng)于參考一個引用的其它類或方法，用法同see also，其中cref里的如果引用的其它地方的方法或類，要帶上全路徑，如果用Sandcastle Help File Builder來生成文檔時，這個引用的類也應(yīng)該在生成文檔的范圍，否則無法跳轉(zhuǎn),msdn的部分描述如下：xml 文檔標(biāo)記中的 cref 特性表示“代碼引用”。它指定標(biāo)記的內(nèi)部文本是代碼元素，如類型、方法或?qū)傩浴?諸如 Sandcastle 這樣的文檔工具使用 cref 特性，自動生成指向所記錄類型或成員的頁面的超鏈接。
 cref特性可參見
關(guān)于第三方工具生成文檔的可以參見
1 Sandcastle Help File Builder
下面是一個生成的文檔的例子，如圖：
2 swagger-ui 
swagger 更適合生成restful風(fēng)格api的文檔，而且可以直接在頁面上測試這個接口。
--- end ---