C＃xml文檔

Question

裝配隨附的.xml文檔文件的用途是什麼（.dll文件）。

我知道，如何構建一個（as here, for example），但他們可以使用什麼？

另外，如果這個文檔可以集成到MS Visual Studio環境中，那應該怎麼做？

Answer 1

如果將XML文件放入與DLL相同的文件夾中，Visual Studio將在IntelliSense中顯示說明。 （包括參數工具提示）

Answer 2

將xml文檔與推薦標籤結合使用可大大提高外部類使用代碼時的可讀性。

另外，您可以使用Sandcastle等工具從xml註釋中生成幫助文檔。該工具生成一個chm文件，它與您在msdn for .NET類中看到的文檔非常相似。

至於集成到Visual Studio環境中，它會自動完成，並且只要您創建項目就會發生。在使用記錄的類/方法/屬性時，Intellisense功能顯示xml註釋。另外，免費的Visual Studio工具，如Ghost Doc（來自SubMain），允許您使用鍵盤快捷方式生成大部分標籤！