如何使用Intellisense工具提示中显示包含的Xml文档中的内容 <include> 标签

Question

我试图整理包含大量代码的类。 我也想很好地记录文件。 不幸的是，对我而言，一次完成所有这些操作会给个人造成混乱。 它很粗糙，而且为了快速开发，会产生大量不必要的引人注意的文本以进行梳理。

<include>似乎很有希望在保持智能感知功能的同时实现这一目标。 也就是说，包含的Xml文档摘要将显示在工具提示中，就像在方法上方声明Xml文档一样。

也许我误解了<include> ，但是我这样做了，并且工具提示没有包含另一个文件中的Xml文档。

这是我现在设置的方式：

/// <include file='xml_include_tag.xml' path='include/member[@name="Foo"]/*' />
private String Foo()
{
    return "Foo";
}

Xml文件如下所示：

<include>

    <member name="Foo">
        <summary>
            Returns "Foo"
        </summary>
        <returns></returns>
   </member>

</include>

我是否正确使用了此工具，或者使用提供的工具集甚至无法做到这一点？

提前致谢！

Answer 1

该文档尚不完全清楚，但似乎Visual Studio C＃编辑器中的IntelliSense不支持此功能（至少在VS2013中）。 太糟糕了，它似乎很有用。

相反，它似乎只能与项目属性（“构建”部分）中的“ XML文档文件”选项一起使用，该选项会输出预期的XML。

请注意，您的XML文件与XPath语句不太匹配-您需要在<member>元素周围包裹一个名为<include>的根元素，以使其匹配。