用于覆盖/实现摘要XML的StyleCop插件

本文关键字：XML StyleCop 插件 覆盖 实现 用于 | 更新日期: 2023-09-27 17:59:11

当谈到StyleCop时，我异常挑剔。我喜欢确保我的类库布局良好，可维护，并有适当的文档。

举个例子，我创建了一个接口：

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

然后我实现了我的接口

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

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

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

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

用于覆盖/实现摘要XML的StyleCop插件

您正在寻找GhostDoc。这个价格很值得，它可以满足你的需求，还可以从头开始为许多不同的方法和属性写评论。

这只是初始问题的切线，GhostDoc是正确答案。这只是一个替代方案：

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

相关文章：