.net - XML 注释——您如何（或在哪里）为您的命名空间和库创建 XML 注释？

Question

我知道，如果您///在类、字段、方法或属性之上，Visual Studio 将开始为您建立 XML 样式的注释。

但是，我在哪里可以为我的命名空间和/或库添加 XML 注释...

例如：

• .NET 框架类库
  • System.Collections 命名空间
    1. System.Collections 命名空间
    2. System.Collections.Concurrent 命名空间
    3. ...

我不确定这些页面是手动创建的，还是通过在适当位置添加的 XML 样式注释自动创建的？

Answer 1

这取决于您用来生成文档的工具。我相信，使用NDoc，您只需在要NamespaceDoc记录的命名空间内创建一个名为的类。然后将使用该类的 XML-Comment。

由于这个问题被标记为“沙堡”，我假设你确实在使用它。如果是这样，这个 SO 答案应该提供详细信息。

Update: OK, I just (in that same thread) saw that apparently Sandcastle understands NamespaceDoc-classes as well. Somebody might want to close this question as a duplicate.

Answer 2

要生成 xml 文件，您需要在项目属性中打开它。它是项目属性选项卡上XML documentation file的复选框。Build

如果打开它并重新编译程序集，则会在程序集旁边出现一个与该程序集同名的 xml 文件。

然后，您可以使用 sandcastle 之类的工具为您的代码创建帮助文件。sandcastle 实际上是一套工具，您可以使用它来自定义生成帮助文件的整个过程。此路径将需要大量阅读沙堡帮助文件和教程。

在 sandcastle 安装的示例文件夹中还有一个工具，可让您快速生成帮助文件，但提供的定制化程度较低。

在过去，我使用了一个名为“DocProject”的 Visual Studio 插件一段时间。我不确定它是否仍然有效，但如果您有兴趣可以在 codeplex 上找到它：http: //docproject.codeplex.com/

根据 Microsoft 的说法，您所指的 MSDN 示例不是通过///从源代码中提取标签创建的，而是与拆分程序员和文档编制部门有关，而不是其他任何事情。