PullThroughDoc 1.4.1

This extension provides an analyzer with code fix that gives you the opportunity to pull through documentation from a base class or interface member. For example, if you have this interface:

interface IMyInterface 
{
    /// <summary>
    /// This method does something
    /// </summary>
    void DoSomething();
}

And this class:

class MyClass : IMyInterface
{
    public void DoSomething();
}

The code fix will allow you to pull through the documentation from the interface declaration to the class, resulting in this:

class MyClass : IMyInterface
{
    /// <summary>
    /// This method does something
    /// </summary>
    public void DoSomething();
}

Alternatively, it will give the option to insert <inheritdoc/> instead (or even switch between the two):

class MyClass : IMyInterface
{
    /// <inheritdoc/>
    public void DoSomething();
}

The diagnostic is hidden and will show up if you open the quick actions lightbulb when:

• Your cursor is on a member name
• One of the following is true:
  • The base member (see below) has documentation and the override member does not
  • The override member has <summary> documentation (giving you the option to switch to <inheritdoc>)
  • The override member has <inheritdoc> (giving you the option to switch to <summary>)

The "base member" can be located in

• A class in the same solution, like MyClass.BaseMember() (this works the best as the documentation is available in the source code)
• An external library, like Object.ToString(). This should mostly work, but does have some limitations and caveats - see this issue if you are having problems with the analyzer/code fix. If you don't think your problem falls into any of the caveats outlined, submit a new issue