Sandcastle is a documentation compiler for Managed class library that generates Microsoft-style Help topics, both conceptual and API reference. It creates API reference topics by combining the XML documentation comments (/// in C# or
' in VB) that are embedded in your source code with the syntax and structure of the types, which it acquires from reflecting against the associated .NET Framework assembly. Skeletal topics are created by using reflection on your project assembly (.dll)
file. Additional content, such as remarks and parameter descriptions, is derived from text in the /// comments in your c# source code or ' comments in your VB source code. Conceptual topics are created by converting XML documents that you author.
In This Section
Sandcastle Features and Requirements
Lists the tools and features that Sandcastle provides, and also describes the system requirements.
How to: Install Sandcastle
Shows how to install Sandcastle.
Sandcastle Architecture and Operation
Shows how the parts of Sandcastle work together as a whole.
Walkthrough: Build Conceptual Help Topics
Teaches how to use Sandcastle to create a conceptual Help file.
Walkthrough: Build API Reference Help Topics
Teaches how to use Sandcastle to create an API reference Help file.
Sandcastle Configuration Files
Provides information about the configuration files that are used to customize the operation of Sandcastle.