StyleCop plugin for overriding / implementing summary XML [closed]

Question

Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines. It is not currently accepting answers.

---

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

I am exceptionally anal when it comes to StyleCop. I like to ensure that my class libraries are well laid out, maintainable, and appropriately documented.

Say for example I create an interface:

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

and then I implement my interface

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

StyleCop will now complain that I have not added a summary tag to my method implementation, however I have a summary tag on the interface.

Are there any known plugins that will automatically copy summary tags where available?

Note: I would like this to work for interface implementations and method overrides.

Answer 1

You are looking for GhostDoc. Well worth the price, it will do what you are looking for, plus write comments from scratch for many different methods and properties.

Answer 2

This is just a tangent to your initial problem and GhostDoc is the correct answer. This is just an alternative:

You could also be able to use the <inheritdoc /> tag for any classes that have derived this interface.