Resharper可以从基类复制XML注释

问题描述 投票:6回答:6

我有一个继承的类,我覆盖的方法应该与基数具有相同的注释。 resharper有复制它们的选项吗?

resharper
6个回答
18
投票

除了上面提到的上下文操作(我觉得申请每个继承的成员相当繁琐)之外,您还可以在实现基类或接口时将ReSharper配置为默认“下拉”注释。

为此,从ReSharper主菜单转到此处的Options | Code Editing | Member Generation | Other Options,您将看到从重写成员复制XML文档的选项,如果选中此选项,ReSharper将自动为您复制所有继承的文档。


9
投票

从ReSharper的3.0版本开始,你应该有一个context action可以做到这一点,从基础复制评论。如果它似乎不可用,请确保在ReSharper | Options | Languages | C# | Context Actions中检查它。


2
投票

让您重写的方法取消注释。所以R#short help(Ctrl + Shift + F1)会自动显示基类成员的帮助。


1
投票

这是Can I propagate XML documentation from an interface to its implementation?的副本

Answer:从每个方法名称按Alt + Ins,选择“从基础复制注释”。正如accepted answer所示,您必须启用此选项。


0
投票

这是一个较老的问题,但我想我会补充一点,resharper支持标签

     /// <inheritdoc />

有了这个,界面的注释也显示在intellisense的工具提示中。


0
投票

我构建了一个工具来对XML文档文件进行后处理,增加了对<inheritdoc />标记的支持。

虽然它对源代码中的Intellisense没有帮助,但它确实允许修改后的XML文档文件包含在NuGet包中,因此可以在引用的NuGet包中使用Intellisense。

有关更多信息,请访问www.inheritdoc.io(免费版)。

© www.soinside.com 2019 - 2024. All rights reserved.