在C#中继承文档？

Question

从Java和Eclipse我习惯于@inheritDoc允许使用与基类/方法相同的文档.

如何在C#和Visual Studio 2010中完成类似的操作？

Answer 1

即使这个问题还有几年的历史,它专门用于Visual Studio 2010.对于Google所有这些人来说,我想添加一个我找到的答案,并且适用于Visual Studio 2015和Sandcastle帮助文件生成器(SHFB):

/// <inheritdoc/>

可用于从基类或接口继承文档.

这里是Sandcastle帮助文件生成器(SHFB)文档的链接: 使用<inheritdoc />标记

Answer 2

它在香草VS中不存在.你最好的选择是ghostdoc或类似的.这可以在Extension Manager中找到,也可以在这里找到

Answer 3

支持<inheritdoc/>Visual Studio 2019 Update 16.4中实现了

它的文档在这里。

<inheritdoc [cref=""] [path=""]/>

从基类、接口和类似方法继承 XML 注释。使用inheritdoc 可以消除不必要的重复XML 注释的复制和粘贴，并自动保持XML 注释同步。请注意，当您将标签添加到类型时，所有成员也将继承注释。

• cref：指定要从中继承文档的成员。当前成员上已定义的标签不会被继承的标签覆盖。
• 路径：将产生要显示的节点集的 XPath 表达式查询。您可以使用此属性来过滤要在继承的文档中包含或排除的标签。在基类或接口中添加 XML 注释，并让继承文档将注释复制到实现类。

将 XML 注释添加到您的同步方法中，并让heritdoc 将注释复制到相同方法的异步版本中。如果要复制特定成员的注释，可以使用 cref 属性来指定该成员。