Can implementation classes "inherit" XML comments from their implemented interfaces?

Question

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?

score 6 · Answer 1 · edited May 23 '17 at 12:24

6

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#

edited May 23 '17 at 12:24

Community

1
1

answered Jan 23 '12 at 12:52

Benoit Blanchon

13,364
4
73
81

score 3 · Accepted Answer · answered Apr 06 '09 at 16:31

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

K Johnson · Answer 3 · 2017-12-21T00:08:22.723

0

In case anyone else is looking for a solution, I built a library to post-process the XML documentation files to add support for an <inheritdoc/> tag.

More info at www.inheritdoc.io (free version available).

edited Dec 21 '17 at 00:08

answered Dec 20 '17 at 23:55

K Johnson

478
5
14

Can implementation classes "inherit" XML comments from their implemented interfaces?

3 Answers3