Add IntelliSense support for the <inheritdoc /> tag in XML documentation comments
We currently use the <inheritdoc /> and <inheritdoc cref="" /> tags extensively in our code base in order to reduce the amount of duplicated documentation that needs to be written.
This works great for the most part, since we generate our docs using Sandcastle.
However, when we are actually developing code in the same c# project as the API which uses <inheritdoc>, Visual Studio does not recognize the tag, or resolve any references.
It would be great if Visual Studio Intellisense could actually do this.
Rob Siklos commented
@Ryan: That is certainly not the best flow. If a class implements an interface, then the interface documentation is the "contract", and that must be correct. If the interface documentation changes, developers can't be expected to find all the implementations and duplicate those changes in the implementation's doc. DRY principle anyone? The whole point of inheritdoc in the first place is to avoid having to do those kinds of things.
If the class needs a different value that what's coming from the interface, that's perfectly fine, and perfectly allowable when using inheritdoc - specific parts can be inherited and/or overridden.
Just copy the comments when you implement or override. That's the best flow. That saves time, encourages documentation, and allows changing of documentation should a class need a different value than an interface.
Please delete this suggestion and move all votes to the duplicate suggestion item
How come this doesn't get many votes? What's the alternative?
What SC said: automatically do this for overridden methods when no documentation is supplied. (and don't forget to do this for parameters)
Matthew King commented
This would be incredibly helpful.
Joshua Merchant commented
Please add native support to visual studio for inheritdoc. See sandcastle's implementation for reference.
Ed Andersen commented
I would like to be able to override specific tags of inherited documentation or add new tags, thus an <inheritdoc/> tag would be really helpful.
Or even better, automatically do this for overridden methods when no documentation is supplied.