c# - 是否可以从特定参数继承文档？

Question

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 不显示该特定参数的文档，而是显示我试图从中继承文档的方法的第一个参数的文档。

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

Answer 1

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>
  

Answer 2

由于这里的 UserVoice 项，我认为根本不可能在 IntelliSense 中显示继承的文档。