问题标签 [inheritdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
c# - 是否可以从特定参数继承文档?
Visual Studio 2017、ReSharper 2017、C# 项目
我试图通过使用select
属性来继承方法参数的文档,但它似乎没有按预期工作。
根据这篇文章(http://tunnelvisionlabs.github.io/SHFB/docs-master/SandcastleBuilder/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm)可以使用select
属性过滤文档,其中一个示例显示它被这样使用:
因此,我以类似的方式尝试以这种方式过滤文档:
但问题在于 Visul Studio Intellisense 不显示该特定参数的文档,而是显示我试图从中继承文档的方法的第一个参数的文档。
所以我的问题是:是否可以将文档过滤到方法的特定参数?
c# - 我可以用吗引用另一个变量的 XML 摘要?
当我为我的项目编写函数时,更具体地说,他们的 XML 文档注释,我发现自己经常重复特定参数的注释。这有时会导致误导性文档(因为复制粘贴通常会......)。
这是我想到的一个简单的例子,它代表了真正的问题。
在这一行/// <param name="number"><inheritdoc cref="myNumber"/></param>
中,我想要文本“应该加倍的数字”,但它没有出现。也许我不完全理解inheritdoc的使用。
我所说的出现是这个意思。Visual Studio 应该number
在该框中显示文档:
这就是它的样子(无需复制粘贴文本):
那么,有没有办法在 XML 文档注释中引用不同的变量?
c# - 有隐含的<inheritdoc />吗?
在 Visual Studio 中,我注意到当我悬停一个方法时,它的行为就像有一个 <inheritdoc />,而实际上没有。
为什么以及从哪里来?因为 Visual Studio?
另外,我应该添加 <inheritdoc /> 还是留下它,你怎么看?
非常感谢!