Search code examples
c#sandcastle

Embedding a region of code in a help file

I am using sandcastle to build my help file.

Is there a way to add code samples from actual C# files? Ideally, I would have C# files with region, reference the region from sandcastle. Sandcastle would then embed the content of the region when building. Is this feasible?

Solution

  • Yes, you can use the <example> tag.

    Here's a reference of tags you can use: Recommended Tags for Documentation Comments