Search code examples
.netdocumentationchmxml-documentation

XML Documentation Comments with Interfaces and implementing class(es)

I am documenting an assembly using XML Documentation Comments, from which a chm file will be created using Sandcastle.

My assembly contains various interfaces, each of which is implemented by one class (in my scenario these are WCF services).

I have added documentation to the interfaces, is there any way for me to automatically document the relevant methods on the implementing classes?

Solution

  • There seems to not be any support for such autodocumentation in Sandcastle. The Sandcastle Help File Builder though implements a custom inheritdoc tag.

    From the SHFB site:

    Support is included for the <inheritdoc /> tag which allows you to inherit documentation from base types/members. This is implemented via a standalone tool so it can also be used by other third-party tools and build scripts. This tool provides features beyond those found in the build component supplied with Sandcastle.

    Second Update: according to this workitem, the Sandcastle "support" for inheritdoc is through the SHFB tool. Bottom line I suppose is, SHFB solves your problem.