是否可以从特定参数继承文档?

2024-04-02

Visual Studio 2017、ReSharper 2017、 C# 项目

我试图通过使用继承方法参数的文档select属性,但它似乎没有按预期工作。

根据这篇文章(http://tunnelvisionlabs.github.io/SHFB/docs-master/SandcastleBuilder/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm http://tunnelvisionlabs.github.io/SHFB/docs-master/SandcastleBuilder/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm)文档可以使用过滤select属性,示例之一显示了它的使用方式:

 /// <example>
 /// <inheritdoc cref="MethodWithTwoExamples"
 ///     select="span[@id='Example 2']" />
 /// </example>

因此,以类似的方式,我尝试以这种方式过滤文档:

/// <param name="generateStream"><inheritdoc cref="MyClass.MyMethod" select="param[@name='generateStream']"/></param>

但问题是 Visul Studio Intellisense 不显示该特定参数的文档,而是显示我试图从中继承文档的方法的第一个参数的文档。

所以我的问题是:是否可以将文档过滤到方法的特定参数?


Visual Studio 2019 (16.9.3) 可以满足您的要求。 我自己也遇到了同样的问题,并在这里找到了讨论:

https://github.com/doxygen/doxygen/issues/7356/#issuecomment-547905295 https://github.com/doxygen/doxygen/issues/7356/#issuecomment-547905295

这为我指明了正确的方向。

  • 首先,作为select已被弃用,你必须使用path反而。

  • 其次,您必须在 XPath 部分前面加上斜杠 (/) 以便 你的 XML 文档将如下所示:

    /// <param name="generateStream"><inheritdoc cref="MyClass.MyMethod" path="/param[@name='generateStream']"/></param>
    
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

是否可以从特定参数继承文档? 的相关文章

随机推荐