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

时间:2017-09-30 15:13:12

标签: c# visual-studio resharper intellisense inheritdoc

Visual Studio 2017,ReSharper 2017, C#项目

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

根据这篇文章(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没有显示该特定参数的文档,而是显示了我试图从中继承文档的方法的第一个参数的文档。

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

2 个答案:

答案 0 :(得分:3)

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

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

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

  • 首先,因为 select 已被弃用,所以您必须改用 path

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

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

答案 1 :(得分:0)

由于此UserVoice项here,我认为根本无法在IntelliSense中显示继承的文档。