Sunday, February 22, 2009

The Formal Documentation

Sandcastle is a documentation tool developed by Microsoft. It generates MSDN-style documentation from

  1. the assemblies metadata obtained by reflecting over the assemblies to be documented and
  2. the XML documentation file generated by the compiler. This file contains the XML comments extracted from the source code.

Sandcastle outputs HTML pages that can be deployed to a website. It can also output a set of files that can be fed to the HTML Help Workshop to generate a compiled help file (.chm).
HTML Help Workshop is a freely downloadable HTML help compiler and is not a part of Sandcastle. You can get the HTML Help Workshop from the Microsoft Download Center.
http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&DisplayLang=en

The following image explains a lot. I got it from a Power Point presentation I downloaded from the official Sandcastle blog.
http://blogs.msdn.com/sandcastle/archive/2006/07/28/681209.aspx



Sandcastle is an open source project hosted on Codeplex. The latest release can be downloaded from
http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx

Sandcastle is a set of command-line programs that are hard to deal with. Luckily, there exists several community tools that provide a GUI front-end for Sandcastle. Examples of these projects are DocProject, Sandcastle Help File Builder, and Sandcastle GUI.

To generate the documentation for my BasicSimulator, I used Sandcastle, Sandcastle Help File Builder, and HTML Help Workshop.

Click here to download the formal documentation.

No comments: