用于覆盖/实现摘要 XML 的 StyleCop 插件 [关闭]答案

【问题标题】：StyleCop plugin for overriding / implementing summary XML [closed]用于覆盖/实现摘要 XML 的 StyleCop 插件 [关闭]
【发布时间】：2014-04-19 15:20:26
【问题描述】：

说到 StyleCop，我非常讨厌。我喜欢确保我的类库布局合理、可维护且文档适当。

比如说我创建了一个接口：

public interface ICustomImpl
{
    /// <summary>
    /// Say hello!
    /// </summary>
    void SayHello();
}

然后我实现我的接口

public class Hello : ICustomImpl
{
    public void SayHello()
    {
        //impl
    }
}

StyleCop 现在会抱怨我没有在我的方法实现中添加摘要标签，但是我在接口上有一个摘要标签。

是否有任何已知的插件可以自动复制可用的摘要标签？

注意：我希望这适用于接口实现和方法覆盖。

【问题讨论】：

标签： c# visual-studio documentation stylecop summary

【解决方案1】：

您正在寻找GhostDoc。物有所值，它可以满足您的需求，并且可以从头开始为许多不同的方法和属性编写 cmets。

【讨论】：

【解决方案2】：

这只是您最初的问题的一个切线，GhostDoc 是正确的答案。这只是一种选择：

您还可以将<inheritdoc /> 标记用于派生此接口的任何类。

【讨论】：