Source Code Documentation with Sandcastle

<< Click to Display Table of Contents >>

Navigation:  More Advanced Procedures >

Source Code Documentation with Sandcastle

Help+Manual includes and integrates the latest version of Microsoft Sandcastle, making it possible for you to generate source code documentation for your .NET development projects directly. You just need to follow some simple rules for commenting and make a single configuration change in your Visual Studio project. Then you can convert the assembly structures and your comments directly into a pre-formatted Help+Manual documentation project.

Unlike the standalone version of Sandcastle, which generates non-editable CHM files directly, this allows you to edit the project in any way you like and publish to all the formats supported by Help+Manual—not just CHM but PDF, WebHelp, Visual Studio Help and so on.

The Sandcastle import option automatically creates a pre-formatted,  pre-structured Help+Manual project from your source code

The Sandcastle import option automatically creates a pre-formatted,
pre-structured Help+Manual project from your source code