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

Ine*_*elp 27 c# resharper intellisense inheritdoc visual-studio

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>
Run Code Online (Sandbox Code Playgroud)

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

/// <param name="generateStream"><inheritdoc cref="MyClass.MyMethod" select="param[@name='generateStream']"/></param>
Run Code Online (Sandbox Code Playgroud)

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

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

mar*_*s s 47

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

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>
    
    Run Code Online (Sandbox Code Playgroud)

  • 已投票且恕我直言,可能应该将其标记为已接受的答案。我意识到OP要求VS2017(根据评论,它显然不支持inheritdoc),但除此之外,它为我提供了我需要的、在MS文档中找不到的信息。 (4认同)