我试图整理包含大量代码的类。我想也很好地记录和记录。不幸的是,对于我来说,所有这一切都在一个文件中为个人的眼睛创造了混乱。它很严重,而且为了快速发展,它会产生大量不必要的引人注目的文字。
<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>
我是否正确使用此功能,或者使用提供的工具集甚至无法实现此功能?
提前致谢!
答案 0 :(得分:0)
文档并不完全清楚,但似乎Visual Studio C#编辑器中的IntelliSense不支持此功能(至少在VS2013中)。太糟糕了,看起来很有用。
相反,它似乎只适用于&#34; XML文档文件&#34;项目属性(构建部分)中的选项,它输出预期的XML。
请注意,您的XML文件与XPath语句不完全匹配 - 您需要一个名为<include>
的根元素包围<member>
元素才能匹配。