將XML文檔添加到WinRT項目的最簡單方法

Question

我們有一組開發人員從C ++遷移到C＃和WinRT。 我們使用D'Oxygen作為C ++開發人員構建的一部分，我希望繼續將文檔生成作為C＃/ WinRT中開發人員構建的一部分。

很容易打開XML Doc生成，我相信這會為格式錯誤的標簽提供警告，但是如果沒有實際的HTML輸出，我認為我們的開發人員將缺少有價值的反饋。

看起來NDoc現在已經不存在了，我快速瀏覽了Sandcastle，但發現它相當復雜。 理想情況下，我正在尋找一些不會過度負擔開發人員的東西，或者要求他們在編輯，構建，測試和提交時記住額外的步驟。 換句話說，最好的解決方案是“剛剛發生”，就像構建后的步驟一樣，並不會顯着增加每個開發人員的構建時間。

如果有人在C＃/ WinRT中有這方面的經驗，我肯定會有一些建議。

提前致謝！

Answer 1

1. 獲取Sandcastle幫助文件生成器 。
2. 在Visual Studio解決方案中為庫創建幫助項目。
3. 從Debug解決方案配置中刪除Build復選標記，僅在Release配置中構建文檔項目，因為Debug最常用於開發期間。 對於發布版本測試或性能測試，您可以創建另一個解決方案配置，也可以只是來回切換選項。
4. 構建文檔一次
5. 在解決方案中包含文檔文件，以便在文件更改時顯示在Pending Changes窗口中。
6. 請您的開發人員使用在簽入前更新文檔的發布配置進行構建，或使用任何其他策略來要求更新文檔。

我不認為一直構建文檔是有意義的，但它有助於使您更容易這樣做，當您真正需要更新版本時 - 您可以非常快速地構建它。

您還可以確保使用FXCop或StyleCop（忘記哪個）並將其配置為將缺少的XML文檔警告視為錯誤 - 至少在發布版本中。 為調試配置執行此操作可能會減慢開發速度並使更改變得困難，因為開發人員通常希望在提交有關文檔的最終實現之前先嘗試一下。

編輯*

Sandcastle提供各種輸出格式，如項目屬性中所示：

Answer 2

我想提一下ForgeDoc （我是開發人員），它可能就是你想要的。 它設計得快速而簡單，它可以生成類似MSDN的HTML輸出。 它還有一個命令行界面，因此您可以從Visual Studio中的生成后事件命令中調用它。

我想你應該試一試，因為我真的很想聽聽你的想法。