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

时间:2014-04-19 15:20:27

标签: c# visual-studio documentation stylecop summary

对于StyleCop,我非常肛门。我希望确保我的类库布局合理,可维护且适当记录。

比如说我创建了一个界面:

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

然后我实现我的界面

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

StyleCop现在会抱怨我没有在方法实现中添加摘要标记,但是我在界面上有一个摘要标记。

是否有任何已知的插件会自动复制摘要标记?

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

2 个答案:

答案 0 :(得分:2)

您正在寻找GhostDoc。非常物有所值,它可以满足您的需求,并可以从头开始为许多不同的方法和属性撰写评论。

答案 1 :(得分:0)

这只是您初始问题的正切,GhostDoc是正确的答案。这只是一个选择:

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