我能否将XML文档从接口传播到其实现?

15

我需要将一个基类的XML文档或接口的实现传播给派生类或实现类。

使用Resharper可以实现吗?

2个回答

20

可以的。

如果您尚未实现或覆盖成员,那么在派生类或接口实现中,单击Alt+Ins,选择“重写成员”或“实现缺少的成员”。在随后显示的向导中,选择要实现/覆盖的成员,并确保选择“复制 XML 文档注释”。

或者,如果您已经有了一个重载或实现的成员,请在重载/实现的成员上按Alt+Enter,然后选择“从基类复制注释”。


如果我更新接口文档,这不需要我更新所有实现方法的所有文档吗?有没有更好的方法来解决这个问题? - Mikkel R. Lund
这确实需要更新所有实现成员的文档,但当您选择维护特定于实现的文档时,这不就是您要寻找的吗? - Jura Gorohovsky

1
从2016.2 EAP 9开始,ReSharper支持<inheritdoc />标签(RSRP-33352)。您可以使用QuickDoc(默认为Ctrl+Shift+F1)查看累积的文档。 成员生成选项页面已经添加了另一个选项,以自动将该标签添加到任何生成的成员中。您还可以在尚未有文档的成员上使用上下文操作。

enter image description here

我还可以推荐XmlDoc Inspections插件,它与该主题有一定关联。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接