XML注释-如何或在何处为名称空间和库创建XML注释？

问题描述

| 我知道，如果您在类，字段，方法或属性的上方“ 0”，Visual Studio将开始为您建立XML样式的注释。 但是，在哪里可以为我的名称空间和/或库添加XML注释... 例如： .NET Framework类库 System.Collections命名空间 System.Collections命名空间 System.Collections.Concurrent命名空间 ... 我不确定这些页面是手动创建的，还是通过在适当位置添加XML样式的注释自动创建的？     

解决方法

这取决于您用来生成文档的工具。我相信，使用ѭ1you，您只需在要记录的命名空间内创建一个名为

NamespaceDoc

的类。然后将使用该类的XML-Comment。 由于该问题以\“ sandcastle \”标记，因此我认为您确实在使用它。如果是这样，则此SO答案应提供详细信息。 更新：好的，我只是（在同一线程中）看到，沙堡显然也了解NamespaceDoc类。有人可能希望将这个问题重复进行。     ,要生成xml文件，您需要在项目属性中将其打开。这是项目属性的“ 4”选项卡上的复选框“ 3”。 如果打开它并重新编译该程序集，则该程序集旁边会出现一个与该程序集同名的xml文件。 然后，您可以使用诸如sandcastle之类的工具来为代码创建帮助文件。 sandcastle实际上是一组工具，可用于自定义生成帮助文件的整个过程。此路径将需要大量阅读sandcastle帮助文件和教程。 在沙堡安装的示例文件夹中还藏有一个工具，可让您快速生成帮助文件，但提供的定制化程度较低。 过去，我使用了一个名为\“ DocProject \”的Visual Studio插件一段时间。我不确定它是否仍处于活动状态，但是如果您有兴趣，可以在codeplex上找到它：http://docproject.codeplex.com/ 根据Microsoft的说法，您引用的MSDN示例并不是通过从其来源中提取“ 0”标记来创建的，而是与分割程序员和文档编制者部门以及其他任何方面有关。