Menu
Curious question. I'm using Microsoft's Sandcastle to generate documentation from the XML comments in my C# code. Several of my classes are implementing interfaces which already have commented methods. I'd rather not duplicate the documentation in both the interface method and the public implemented method. Is there some kind of tag I can use to "inherit" this documentation from the interface?
248
C# documentation comments use XML elements to define the structure of the output documentation. One consequence of this feature is that you can add any valid XML in your documentation comments. The C# compiler copies these elements into the output XML file.
This allows you to inherit documentation from base class libraries without having to add them as documentation assemblies in your project.
You can add <inheritdoc/> in the implementation.
You should have a look on the following thread: Ways to synchronize interface and implementation comments in C#
140
This feature does not exist currently in Visual Studio.
You can get third party tools, such as GhostDoc that will help with creating XML documentation. GhostDoc also has the option to generate documentation that was "inherited" like you are attempting to do.
Link: GhostDoc
27
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
