【问题标题】:Can I propagate XML documentation from an interface to its implementation?我可以将 XML 文档从接口传播到其实现吗?
【发布时间】:2011-08-27 21:47:33
【问题描述】:

我需要将 XML 文档从基类传播到派生类或从接口传播到实现。

我可以使用 Resharper 做到这一点吗?

【问题讨论】:

    标签: visual-studio resharper xml-documentation


    【解决方案1】:

    是的,你可以。

    如果你还没有实现/覆盖成员,那么在派生类或接口实现中,点击Alt+Ins,选择“覆盖成员”或“实现”失踪的成员”。在随后显示的向导中,选择要实现/覆盖的成员,并确保选择“复制 XML 文档”。

    或者,如果您已经有一个覆盖或实现的成员,请在覆盖/实现的成员上按 Alt+Enter,然后选择“从基础复制 cmets” .

    【讨论】:

    • 如果我更新接口文档,这不会要求我更新所有实现方法的所有文档吗?难道没有更好的方法吗?
    • 这确实需要更新所有实施成员的文档,但是当您选择维护特定于实施的文档时,这不是您要寻找的吗?
    【解决方案2】:

    从 2016.2 EAP 9 开始,ReSharper 支持 <inheritdoc /> 标签 (RSRP-33352)。您将使用 QuickDoc 看到 累积 文档(默认为 Ctrl+Shift+F1)。

    Members Generation 选项页面已被另一个选项扩展,以自动将该标签添加到任何生成的成员。您还将对还没有文档的成员进行上下文操作。

    我还可以推荐XmlDoc Inspections plugin,它与主题有某种关系。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2013-09-29
      • 1970-01-01
      • 1970-01-01
      • 2011-06-15
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多