強制Visual C++僅爲我的文件生成XML註釋？

有一個問題，我似乎無法找到直接的答案。我正處於與幾個朋友一起構建遊戲引擎的後期階段，在這一點上，我們正在考慮簡化評論，以便讓他們對可能希望加入團隊的開發人員更具可讀性和實用性。由於我們使用Visual Studio 2010，嵌入式XML評論似乎是最理想的工具，而且它是！我們遇到的唯一問題是我們的引擎基於的圖形庫似乎具有相同的想法，並且也使用類似於XML的註釋模式。不幸的是，他們用來編譯XML註釋的任何工具的語法都與Visual Studio中使用的不同，因此當Visual Studio嘗試將其註釋呈現給項目XML輸出文件時，我們所得到的只是一大串錯誤因爲我們只想要我們的代碼的文檔，所以無論如何都是完全不需要的。所以，簡而言之，是否有一些編譯參數或選項可以在Visual Studio/VC++中設置，這會強制它僅爲我們的類和文檔生成XML註釋輸出文件？非常感謝。強制Visual C++僅爲我的文件生成XML註釋？

來源

2011-05-27 DaveStance

或者您可以刪除他們的評論？我很好奇VS應該知道哪些文件是你的。 – Fosco 2011-05-27 18:40:08

@Fosco - 只存在於項目文件夾或解決方案中的那些？它爲包含在我的項目中的頭文件生成註釋，所以鏈接器自然會將它們包含在整個編譯時環境中，但由於它們實際上並不駐留在我的項目文件夾中或在當前解決方案中打開， XML解析器應該能夠區分這兩者之間似乎並不牽強？ – DaveStance 2011-05-27 18:55:04

忘記Visual Studio並使用像doxygen這樣的真實文檔生成工具。它處理基於MS XML的文檔，您可以將其配置爲僅搜索某些文件或目錄。

編輯 Doxygen的有它自己的文檔標記格式described here但它也能處理的JavaDoc風格的註釋。 XML樣式註釋是described here。

來源

2011-05-27 18:46:49

你是男人！謝謝你，這個工具非常棒！我很驚訝，當我對自動C++文檔進行一般搜索時，沒有得到更多關注。 – DaveStance 2011-05-27 19:16:59

沒問題。就我個人而言，我更喜歡Doxygen自己的XML標記標記（少打字，更好的功能）。我不知道你是否有要求使用XML標記，但如果你不這樣做，我會建議使用doxygen的標記，甚至是JavaDoc標記。另一方面，Visual Studio會自動爲您標出XML標記，並且您可以混合使用doxygen樣式標記... – 2011-05-27 19:55:26

強制Visual C++僅爲我的文件生成XML註釋？

回答

相關問題