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-Comment。

由于问题标有“sandcastle”，我假设您确实在使用它。如果是这样，this SO answer应该提供详细信息。

更新：好的，我只是（in that same thread）看到Sandcastle显然也了解NamespaceDoc-classes。有人可能希望将此问题视为重复。

Answer 2

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

如果你打开它并重新编译程序集，那么程序集旁边会出现一个xml文件，其名称与该程序集相同。

然后，您可以使用sandcastle等工具为您的代码创建帮助文件。 sandcastle实际上是一组工具，可用于自定义生成帮助文件的整个过程。这条路径需要大量阅读sandcastle帮助文件和教程。

沙堡安装的示例文件夹中还有一个工具，可以让您快速生成帮助文件但提供更少的结论。

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

根据Microsoft的说法，您引用的MSDN示例不是通过从其源代码中提取///标记来创建的，而是与分割程序员和文档程序部分以及其他任何内容有关。