2011-01-24 114 views
26

我正在尋找一個很好的工具,可以從我的VS2010 XML文檔創建HTML /幫助文件。我已經發現了一些商業工具,如從VS 2010生成HTML /幫助文件C#XML文檔

我相信有更多的,我只列出這兩個作爲例子。還有一些簡單的XSLT樣式表可以將XML轉換爲HTML文檔。

你在用什麼,例如有沒有一個免費的工具來做轉換,可能是插件。 只是爲了澄清,基本上我已經發現兩種類型的工具:

  1. 的那些轉換在不同的目標格式的XML文檔文件,這是我所期待的。
  2. 幫助我在源代碼中生成XML文檔的工具。這不是(!)我正在尋找的東西。

感謝您的幫助。


沙堡/ SHFB組合工作得很好。感謝所有的幫助。

一些言論:

  1. NDoc的似乎已經過時,最後更新是從2005年開始這就是爲什麼我跳過了這一點。
  2. 一個類似的線程,也非常詳細,可以在這裏找到:How to turn C# Xml Doc-Comments into something useful?感謝您的提示!
  3. 有一些來源沙堡,最新的版本,我發現在這裏位於:http://sandcastle.codeplex.com/
  4. 爲了產生MsHelp2我必須安裝含有hscomp.exe VS 2008 SDK。有一個版本1.0和1.1,據我所知,版本1.0包含編譯器。有關詳細信息,請參見HelixsoftSocial MSDN
  5. 在我的情況下,生成的WebHelp無法正常使用Chrome。它總是重新加載index.html頁面。
  6. topic here顯示如何將命名空間信息添加到sandcastle文檔中。
  7. 更新截至2012年11月:對於我使用的小型項目Doxygen - 我覺得配置起來要容易一些。
+2

可能重複的[如何將C#Xml Doc-Comments變成有用的東西?](http://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something - 有用) – jgauffin 2011-01-24 12:25:31

+0

是的,我出於某些原因沒有看到這個。一旦我檢查了一些工具,我會更新這個。 – 2011-01-24 17:00:50

+1

我可以將NuDoc添加到可用API的列表中以閱讀XML文檔嗎? http://kzu.to/nudoc – kzu 2013-06-11 20:21:11

回答

19

我們使用Sandcastle進行轉換& Sandcastle幫助文件生成器作爲用戶界面來管理幫助項目。在我看來,Sandcastle和SHFB的美妙之處在於,除了「平均」源代碼文檔之外,您還可以添加其他信息,例如程序體系結構,必須遵循的模式或者與您的項目不相關的其他概念內容直接在你的程序中的一個類。這可以通過在Microsoft Authoring Schema的幫助下創建附加的xml文件來完成(可以使用visual studio將其編輯爲xml文件,並且可以使用它的架構)。使用這兩種工具創建MSDN文檔非常容易。

很久以前,我嘗試了docbook,它在技術方面幾乎相同(包含信息和xslt文件的xml文件將其轉換爲各種輸出類型)。但對我們來說,這是沒有選擇的,因爲沒有可以使用visual studio生成的xml文檔的轉換(再加上概念內容的轉換對我們來說非常痛苦)。

3

兩個更自由的工具,允許從XML註釋文檔的創建:

3

沙堡+ SHFB是一個偉大的組合。免費並生成html,chm等