[.NET] 使用Sandcastle Help File Builder,為程式碼建立說明文件檔案

[.NET] 使用Sandcastle Help File Builder,為程式碼建立說明文件檔案

我們必需要為元件寫說明文件檔案,以便專案其他開發人員使用,這時我們可以"使用的文件註解標籤",來為我們的程式碼標上說明,假若我有以下片段程式碼:


{
    /// <summary>
    /// 測試用類別
    /// </summary>
    public class Class1
    {
        /// <summary>
        /// 格式
        /// </summary>
        public enum Formater
        {
            /// <summary>
            /// XML格式
            /// </summary>
            XML = 0,

            /// <summary>
            /// 二進位格式
            /// </summary>
            Bunary = 1
        }
    }
}

如下圖當我使用Formater列舉型別時,VS會自動跳出IntelliSense包含說明

image


這麼方便的東西是一定要學會的,以下就來介紹如何使用,在專案理將建立"XML文件檔案"。

image

 

當方案建置後,xml與exe會在同一目錄產生。

image

 

xml的格式長這樣

image

未來只要把exe與xml一併帶走,便能讓其他人使用

 


xml檔案有了,我們再利用 Sandcastle Help File Builder 來建立,請先到官網下載,解壓縮後安裝

Sandcastle_Jun_2010.msi

SandcastleHelpFileBuilder_1930.msi

image

 

安裝好後開啟應用程式

image

 

建立空的專案:

image

 

加入元件:

image

 

建立參數:

軟體有很多的參數可以設定,試著自己調看看,主要是增加說明文件的資訊

 

參數設定好之後按下"建立專案":

image

 

可以看到專案在執行了,這得花上一些時間。

image

 

完成後就可以觀察一下產生出來的檔案

image


如果你按照以上步驟建立說明檔,有以下問題發生時

SHFB: Error BE0034: The 'WorkingPath' property resolved to 'C:\Users\Yao\Desktop\ClassLibrary1\Help\Help\Working\' which is a reserved folder name.  See error or property topic in help file for details.

image

 

試著找到專案的working資料夾然後砍掉它,再按一次建立專案

image

若有謬誤,煩請告知,新手發帖請多包涵


Microsoft MVP Award 2010~2017 C# 第四季
Microsoft MVP Award 2018~2022 .NET

Image result for microsoft+mvp+logo