使用SHFB（Sandcastle Help File Builder）建立MSDN風格的代碼文檔

根據這兩種圖就下一步下一步的安裝。安裝之后會在你的開始菜單里看到“Sandcastle Help File Builder”這個文件夾如下：

 

第二：我們來簡單的建一個項目，寫一個方法。

    public class Class1
    {
        /// <summary>
        /// 返回一個字符串
        /// </summary>
        /// <returns>字符串</returns>
        public string HelloWord()
        {
            return "歡迎來到 HelloWord 世界！";
        }
        /// <summary>
        /// 根據參數返回一個字符串
        /// </summary>
        /// <param name="str">參數</param>
        /// <returns>字符串</returns>
        /// <example>string str=HelloWord("aaaaaaaaaaa");</example>
        public string HelloWord(string str)
        {
            return str;
        }

    }

 之后設置其屬性如下圖：看到“輸出”一欄，要在xml文檔文件前打勾，路徑使用默認即可。再回來生成一下項目。

第三：打開SHFB，文件新建一個項目，名字自己隨意起，這里以Test為例。

 

在Test項目下Documentation Sources右鍵點擊，選擇 Add Documentation Sources.然后把上一步生成的*.xml文件添加進來如下圖1，然后點擊下圖3，過一點時間會生成如圖3.大功告成。

第四：找到剛才你保存創建的位置，我的是保存在F:\Demo\Help

打開如下圖：

OK，大功告成！這里只是一個簡單的，大伙還可以在琢磨琢磨里面有更多的東東。互相學習交流一下。