XML評論 - 您是如何（或在哪裏）爲命名空間和庫創建XML註釋？

Question

我明白，如果您在類，字段，方法或屬性上方的/// Visual Studio將開始爲您創建XML樣式的註釋。

不過，我能去哪裏添加XML註釋爲我的命名空間和/或庫...

例如：

• .NET Framework Class Library
  • System.Collections Namespaces
    1. System.Collections Namespace
    2. System.Collections.Concurrent Namespace
    3. ...

我不知道，如果是手動創建這些網頁，如果他們自動通過XML風格的註釋創造了合適的位置被添加？

Answer 1

這取決於您用於生成文檔的工具。用NDoc，我相信，你只需要在你要記錄的命名空間內創建一個名爲NamespaceDoc的類。然後可以使用該類的XML註釋。

由於問題標記爲「sandcastle」，因此我假設您確實在使用它。如果是這樣，this SO answer應該提供詳細信息。

更新：好吧，我只是（in that same thread）看到Sandcastle顯然理解NamespaceDoc類。有人可能想要將這個問題作爲重複來解決。

Answer 2

要生成xml文件，您需要在項目屬性中將其打開。這是項目屬性的Build選項卡上的複選框XML documentation file。

如果將其打開並重新編譯程序集，則會在與該程序集同名的程序集旁邊顯示xml文件。

然後，您可以使用沙堡等工具爲您的代碼創建一個幫助文件。 sandcastle實際上是一組工具，可用於自定義生成幫助文件的整個過程。這個路徑將需要大量的閱讀sandcastle幫助文件和教程。

sandcastle安裝的示例文件夾中還有一個工具，它可讓您快速生成幫助文件，但提供較少的cusomization。

在過去，我用了一段名爲「DocProject」的視覺工作室插件。我不知道這是否仍然有效，但如果你能找到它在CodePlex上你的興趣：http://docproject.codeplex.com/

根據您參考不被從源提取///標記創建但是有更多的微軟MSDN的例子做分裂程序員和記錄員deparments然後做任何事情。