類文檔建議

Question

我們是一家微軟商店，專注於使用C＃。我們有幾個項目，包括網站，Windows服務和類庫，都包含了XML註釋。

我正在尋找爲每個項目生成MSDN風格的HTML文檔，並將其部署到所有開發人員都可以輕鬆訪問的集中位置。我也希望自動執行這些步驟，以便它們能夠定期運行，這樣，我和其他開發人員就不必擔心在進行更改時記住生成和部署新文檔。我已經看過Sandcastle和Doxygen，並且都希望能夠生成我想要的文檔，但我需要一個很好的方法來自動生成它，例如在夜間工作或其他方面。

有人在那裏做這樣的事情嗎？我不是最終的結果是HTML出售;特別是如果有更好的主意。

編輯：

我欣賞所有的好主意。現在我可以調查一些路線，但我不知道哪個路線最好，直到我弄髒手。 Sandcastle的幫助文件生成器似乎爲我提供了最好的選擇，所以我會點頭示意這個建議。但是，如果我有更多時間來處理XSLT和CSS解決方案以使XML數據看起來恰到好處，那麼我會首先尋求這一建議。

再次感謝大家！

Answer 1

看看Sandcastle Help File Builder。這使用了獨立的項目，因此您可以隨時隨地創建它們（例如每晚或每次檢入更改時都將其作爲您的系統的一部分）。

Answer 2

我這樣做與我們的項目。基本上我們使用doxywizard來設置配置Doxyfile，它將設置生成的html的規範。然後，在構建服務器的步驟中，我調用「doxygen doxyfile」。

我們的Doxyfile被配置爲在我們的網絡服務器可見的區域生成doxygen文件。因此，每次提交到主幹都會導致文檔自動重建。

Answer 3

您不需要任何第三方工具來生成漂亮的文檔：C＃編譯器可以從XML中輸出XML註釋文檔，您只需要設計一個漂亮的CSS以在瀏覽器中顯示它。如果您不滿意，也可以在應用CSS之前生成自己的XSLT轉換，as described here（在註釋中查找CSS的示例！）。

或者，您可以使用此XML文檔並使用諸如NDoc之類的東西對其進行改進。這是一個nice article關於如何做到這一點，遺憾的是有些過時。

通過運行帶編號/doc:documentationfilename.xml參數的編譯器，您可以隻手動將項目的文檔構建到單個XML文件中。

您也可以在Visual Studio中（項目屬性 - >文檔）指示將此選項添加到項目的每個版本，以便每次構建項目時都會生成XML文件。然後，您可以掛接生成後事件以將XML文件複製到存儲庫。

您也可以在您的Team Foundation Server上設置MS Build以構建文檔並以類似的方式將其複製到存儲庫（/p:DocumentationFile=fileName.xml）;