.net說明文件產生器

摘要:.net說明文件產生器

 一、安裝 Sandcastle

首先安裝微軟的 Sandcastle - Documentation Compiler for Managed Class Libraries

http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

 

二、安裝 Sandcastle Help File Builder

製作HELP 文件,具 UI 界面的工具

http://shfb.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=18639

 

三、製作 HELP 文件

1.撰寫註解

  /// <summary>

    /// 這是測試類別

    /// </summary>

    public class Class1

    {

        /// <summary>

        /// 這是測試方法

        /// </summary>

        /// <param name="a">這是參數</param>

        public static void Test(string a)

        {

 

        }

    }

2.產生xml設定

 

.執行 Sandcastle Help File Builder 程式

1.加入要產生的說明的.dll.xml

 

 

2.設定屬性
選取輸出文件類型

 

 

3.輸出文件

 

 

 

完成後到輸出目錄會找到 .chm的檔案就是了

參考網址

http://itgroup.blueshop.com.tw/jeff377/blog?n=convew&i=3777

http://huan-lin.blogspot.com/2009/02/use-sandcastle-file-builder-to-create.html