Question

Sandcastle Help File Builder (SHFB) turns triple slash comments into documtation like so:

///<summary>A class called Bob</summmary>
public sealed class Bob {}

The schema for the documentation is very robust. However, the more robust and verbose your documentation is the more annoying some people find it to actually browse and edit the source code. A good compromise would be able to do something like

///<summary>A class called Bob</summmary>
///<include href="projectDocs.xml" xpath="/Company/Product/Bob" />
public sealed class Bob {}

Is something like this possible?

Was it helpful?

Solution

Yes, it is possible. There's an include comment tag. Our VSdocman has support for it and I believe Sandcastle has it too.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top