Resharper可以从基类复制XML注释

时间:2011-08-25 06:04:44

标签: resharper

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

6 个答案:

答案 0 :(得分:18)

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

要执行此操作,请从ReSharper主菜单转到此处的Options | Code Editing | Member Generation | Other Options,您将看到从已覆盖成员复制XML文档的选项,如果选中此选项,ReSharper将自动复制所有继承的文档。

enter image description here

答案 1 :(得分:9)

从ReSharper 3.0版开始,您应该有context action可用来执行此操作,从基础复制评论。如果它似乎不可用,请确保已在ReSharper | Options | Languages | C# | Context Actions中签入。

答案 2 :(得分:2)

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

答案 3 :(得分:1)

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

的副本

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

答案 4 :(得分:0)

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

     /// <inheritdoc />

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

答案 5 :(得分:0)

我构建了一个工具来对XML文档文件进行后处理,添加了对&lt; inheritdoc /&gt;的支持。标签

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

请访问www.inheritdoc.io了解更多信息(免费版)。