將C 文件注釋生成 chm幫助文件

2022-01-22 01:11:41 字數 3277 閱讀 2675

完整的文件情訪問:

由於最近需要把以前的乙個專案寫乙個文件,但一時又不知道寫成怎樣的,又恰好發現了可以生成chm的工具,於是乎我就研究了下,感覺還不錯,所以也給大家分享下。好了,不多廢話,下面就來實現一下吧。

生成前的準備

在開始做之前,還是要補充說明一點:我們是通過c#文件注釋生成的xml檔案來生成幫助文件的。因此,第一步就是生成xml文件:

具體步驟:開啟vs->隨意建立乙個專案(這裡我用的是控制台專案),然後新增如下內容:

/// ///人類

///

public classperson

/// ///年齡

///

public int age

/// ///自我介紹

///

/// 姓名

/// 年齡

/// 自我介紹的內容

public string say(string name,stringage )

}

很普通的乙個類,但是要注意下注釋部分,這裡的注釋是文件(不同於」//」的注釋,在vs中敲「///」就是文件注釋)

ps:注意,我這裡person類的訪問修飾符是public,由於我這裡只用了一 個類,如果不加public就會出現「no apis found to document. see error topic in help file for details.」的錯誤。

繼續之前的操作:右擊程式集選擇屬性,選中xml文件檔案:

儲存,編譯,然後在專案的bin\debug目錄下你就會看到生成的xml檔案:

生成chm文件工具介紹

sandcastle是微軟官方的文件生成工具,ndoc開發停止後,這個貌似也是唯一的乙個這方面的工具。它從dll檔案及其xml注釋檔案能夠 生成完整的幫助文件,支援多種生成格式(helpe1x:chm, helper2x:hxs, website,helperview),結合新發布的sandcastle help file builder視覺化工具,整個生成過程十分簡單,而且shfb工具看起來很強大,不僅能夠直接配置生成文件的各個屬性,而且還支援很靈活的擴充套件設定,為 我們提供完美的.net類庫文件成為乙個可能。

sandcastle:點選右側的download大家都懂的。

sandcastle help file builder:

在shfb的壓縮包裡我發現了乙個vs外掛程式,因此接下來我就打算用vs來演示,如果不想裝這個外掛程式的話,可以執行c:\program files (x86)\ewsoftware\sandcastle help file builder\sandcastlebuildergui.exe這個程式,結果都是一樣的

生成chm文件

重頭戲來了,開啟vs,新建專案:

點確定,右側專案結構:

選擇contentlayout.content,看左邊,這裡有一些文件屬性以及版本號等資訊,但是我們這裡用不到,因此刪掉。如果留著也沒事,就是在生成文件的時候頭部多了幾行而已,有興趣的朋友可以繼續研究。

選擇要生成文件的程式集(對應的xml會自動新增),

右擊專案選擇屬性:

到這裡為止可謂是萬事俱備,只欠東風。那麼,東風在**呢?很簡單,生成專案。如果在生成的過程中沒有錯誤的話,那麼在專案目錄的help資料夾下你就會看到:

開啟測試文件:

** :

完整的文件情訪問:

由於最近需要把以前的乙個專案寫乙個文件,但一時又不知道寫成怎樣的,又恰好發現了可以生成chm的工具,於是乎我就研究了下,感覺還不錯,所以也給大家分享下。好了,不多廢話,下面就來實現一下吧。

生成前的準備

在開始做之前,還是要補充說明一點:我們是通過c#文件注釋生成的xml檔案來生成幫助文件的。因此,第一步就是生成xml文件:

具體步驟:開啟vs->隨意建立乙個專案(這裡我用的是控制台專案),然後新增如下內容:

/// ///人類

///

public classperson

/// ///年齡

///

public int age

/// ///自我介紹

///

/// 姓名

/// 年齡

/// 自我介紹的內容

public string say(string name,stringage )

}

很普通的乙個類,但是要注意下注釋部分,這裡的注釋是文件(不同於」//」的注釋,在vs中敲「///」就是文件注釋)

ps:注意,我這裡person類的訪問修飾符是public,由於我這裡只用了一 個類,如果不加public就會出現「no apis found to document. see error topic in help file for details.」的錯誤。

繼續之前的操作:右擊程式集選擇屬性,選中xml文件檔案:

儲存,編譯,然後在專案的bin\debug目錄下你就會看到生成的xml檔案:

生成chm文件工具介紹

sandcastle是微軟官方的文件生成工具,ndoc開發停止後,這個貌似也是唯一的乙個這方面的工具。它從dll檔案及其xml注釋檔案能夠 生成完整的幫助文件,支援多種生成格式(helpe1x:chm, helper2x:hxs, website,helperview),結合新發布的sandcastle help file builder視覺化工具,整個生成過程十分簡單,而且shfb工具看起來很強大,不僅能夠直接配置生成文件的各個屬性,而且還支援很靈活的擴充套件設定,為 我們提供完美的.net類庫文件成為乙個可能。

sandcastle:點選右側的download大家都懂的。

sandcastle help file builder:

在shfb的壓縮包裡我發現了乙個vs外掛程式,因此接下來我就打算用vs來演示,如果不想裝這個外掛程式的話,可以執行c:\program files (x86)\ewsoftware\sandcastle help file builder\sandcastlebuildergui.exe這個程式,結果都是一樣的

生成chm文件

重頭戲來了,開啟vs,新建專案:

點確定,右側專案結構:

選擇contentlayout.content,看左邊,這裡有一些文件屬性以及版本號等資訊,但是我們這裡用不到,因此刪掉。如果留著也沒事,就是在生成文件的時候頭部多了幾行而已,有興趣的朋友可以繼續研究。

選擇要生成文件的程式集(對應的xml會自動新增),

右擊專案選擇屬性:

到這裡為止可謂是萬事俱備,只欠東風。那麼,東風在**呢?很簡單,生成專案。如果在生成的過程中沒有錯誤的話,那麼在專案目錄的help資料夾下你就會看到:

開啟測試文件:

** :

使用C XML 文件注釋生成API幫助文件

c xml 文件注釋 description 描述型別或型別成員。description 物件的摘要。description 新增有關某個型別的資訊,從而補充由 所指定的資訊。description 成員的說明。description 使用方法或其他庫成員的示例。這通常涉及使用標記。descript...

chm幫助文件製作及C 呼叫

注意將word檔案匯出成 篩選的html 方法一 通過.net framework提供的help類來完成chm幫助檔案的呼叫。for example 1.顯示指定 url 處的幫助檔案內容。string helpfile helpfile.chm help.showhelp this,helpfil...

使用EasyCHM生成CHM文件

方式一 從0開始生成 1 把doc文件拆分成多個doc,每個章節乙個doc 2 把每個doc文件都轉換成網頁 2.1 開啟doc後,另存為 篩選過的網頁 之後彈出的格式警告,選擇 是 2.2 記得把所有生成的htm檔案都放在同乙個資料夾裡,以方便easychm.exe的目錄選擇 3 easychm設...