Visual Studio XML 外部注释文件不起作用

Posted 2023-02-22

【中文标题】Visual Studio XML 外部注释文件不起作用

【英文标题】：Visual Studio XML external comments file does not work

【发布时间】：2013-12-17 06:24:28

【问题描述】：

通过使用 include 标记，我试图将我的代码的 cmets 放在单独的文件“docs.xml”中。 但它不起作用。我一直在尝试 C# 和 VB.NET 项目。

这是我的 cmets 文件：

<?xml version="1.0" encoding="utf-8" ?>
<d>
<summary>Demo summary</summary>
</d>

我有一个 ABC 类，只有一个属性 Demo。在我写这个属性之前：

/// <include file="docs.xml" path="d/*" />

或在 VB.NET 中：

''' <include file="docs.xml" path="d/*" />

但是 ABC.Demo 的摘要从未出现在 InteliSense/对象浏览器/另一个项目中（如果我引用我的项目）。

我有一种强烈的感觉，我在这里遗漏了一些东西。

附：我尝试过遵循 XML 文件的“path[@name=]”模式，但没有帮助。

【问题讨论】：

Does <include> comment tag suppress intellisense? 的可能重复项

您使用的是什么版本的 Visual Studio？

在 2010 年、2012 年、2013 年尝试过。

【参考方案1】：

也许您当时已经在文档中看到了这一点，但如果我理解正确，您必须执行以下操作：

在 Visual Studio 中，您在 Build 中指定 XML doc cmets 选项 项目设计器的窗格。 当 C# 编译器看到 标记，它将在 xml_include_tag.doc 中搜索文档 cmets 而不是当前的源文件。