Search This Blog

Friday, April 17, 2009

UI for SandCastle

Great Walk through using SandCastle on CodeProject

Several Important Steps:
1) Install SandCastle from MS.
2) Install this UI - UI for SandCastle
3) Add XMl document for output on each project
4) Add all reference DLL that would appear in the Bin\Debug folder of the solution.
5) Select htmlDoc1 for a CHM style distributable help format.
6) Run help generator.

Welcome to the Sandcastle Help File Builder

Sandcastle, created by Microsoft, is a tool used for creating MSDN-style documentation from .NET assemblies and their associated XML comments files. The current version is the May 2008 release. It is command line based and has no GUI front-end, project management features, or an automated build process like those that you can find in NDoc. The Sandcastle Help File Builder was created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide graphical and command line based tools to build a help file in an automated fashion.

Tip: See the Installation Instructions for information about the required set of additional tools that need to be installed, where to get them, and how to make sure everything is configured correctly.

Tip: If you are new to Sandcastle and the help file builder, see the topics in the Getting Started section to get familiar with it, set up your projects to produce XML comments, and create a help file project.

No comments: