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.

Related Sections
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.

Last edited Mar 22, 2009 at 9:04 PM by aram, version 1

Comments

keith5000 Apr 13, 2011 at 7:32 PM 
Almost 2 years later and still no online documentation? FAIL.

Koeikan Apr 11, 2011 at 9:34 PM 
Apparently, Sandcastle should have used Sandcastle...

APeter Feb 15, 2011 at 4:43 AM 
Yes, none of the Related Sections Links are opening.

jbennettnc Dec 7, 2010 at 4:02 PM 
This should be integrated into the IDE in Visual Studio. Select a project, click "generate help." SandCastle seems to be MS's red-headed step-child. Too bad. This could be very useful.

Dolot Jul 19, 2010 at 10:35 PM 
http://shfb.codeplex.com/
This is the location where you can download sandcastle builder - a GUI frontend for sandcastle. It has the walkthroughs in its documentation (help file).

Mike134 Jul 7, 2010 at 9:49 PM 
I would have to agree that the critical pieces Architecture and the two Walkthroughs should receive some priority. The success of any IT project for any audience can be directly related to how easy the targets can get up and going.

davedev Jan 4, 2010 at 8:03 AM 
Take a look at the documentation on the Sandcastle Styles project for now.

http://sandcastlestyles.codeplex.com/documentation#MoreReading

edvaldig Aug 27, 2009 at 3:23 PM 
hahaha signed up just to tell you I agree, I just installed and was hoping for a convenient NDoc replacement. No documentation and no clue what exactly to do next ... except for digging around of course :) Great effort though, won´t complain about that.

NameOfTheDragon Aug 24, 2009 at 4:17 PM 
Does anyone find it ironic that most of the documentation is missing?