為我的應用程序制作幫助文件

Question

我正在使用舊版應用程序，實際上是在C＃.NET中從頭開始重寫它。 它曾經使用WinHelp向用戶提供某種幫助，但是Vista（我正在開發的系統）說它不支持WinHelp。 所以我要問的是：

如何從C＃.NET創建類似的系統？ 我希望新功能可以在Vista，XP和以前的Windows版本中使用。

Answer 1

使用CHM文件而不是幾乎不推薦使用的WinHelp文件。 您可以使用HTML幫助工作室來創建這些文件。

Answer 2

您可以嘗試“ 幫助和手冊” 。 這是一個很棒的工具。

Answer 3

您現在真的想研究使用Microsoft Sandcastle文檔生成器。 它完全能夠生成HTML幫助v1.0 / 1.1文件（CHM）或v2.0（用於集成到Visual Studio幫助中）。 實際的.NET Framework開發團隊使用它（或它的變體）來為BCL創建API文檔，因此您應該對它的功能有所了解。 我不確定您打算使用的文檔的確切性質，但是Sandcastle可以使用其自定義MAML（XML）來生成API文檔和隨附的幫助頁面（指南，教程，示例，白皮書，詞匯表等） -like）標記語言，本質上就是在代碼中的XML注釋中使用的標記語言。

這是Sandcastle入門的基本指南，但我懷疑您只需要對其進行一些了解即可。 學習曲線也不是特別陡峭，除非您堅持要從命令行學習它。 到目前為止，最簡單的選擇是使用Sandcastle幫助文件構建器GUI ，它是一流的工具，完全沒有限制。

另一個有用的資源是本C＃XML文檔指南 ，該指南向您展示如何使用XML注釋正確地記錄API，這些注釋可以轉換為CHM文檔和IntelliSense。