TechnicalArchitectureWorx

The (Unofficial) ITWorx Technical Architecture Blog

Generating Documentation for .NET assemblies using SandCastle

Posted by archworx on June 4, 2007

I was developing a Control Library for .NET 2.0 and wanted to generate neat looking documentation from XML tags that I had written in code. So I googled around for a bit until I found that you can use a tool called SandCastle to generate HTML documentation that could be transformed into CHM and HxS formats. Here are the steps you have to do:

1- Inside VS2005 right click your project in the Solution Explorer and choose ”Properties”.

2- Click “Build” tab, under “Ouput” make sure that you check the “XML documentation file” checkbox. Once you do so, you can fill in a textbox that specifies the path of where the XML file (that contains the tags you put in code) will be generated.

3- Download and Install HTML Help Workshop .

3- Download and Install SandCastle March 2007 CTP .

4- Download and Install SandCastle Help File Builder (A really cool project on CodePlex that provides a UI that utilizes Sandcastle to generate Help Files)

5- Use SandCastle Help file Builder to generate your documentation .

Voila, you’ve got a cool professional documentation for your .NET project

5 Responses to “Generating Documentation for .NET assemblies using SandCastle”

  1. michael said

    You can also add your class diagrams to the documentation using Drawbridge found as http://www.castleapps.com.

  2. Sandcastle October 2007 CTP released

    http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

  3. Sandcastle January 2008 Released on Codeplex

    You can download the release here
    http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=9921

  4. […] is recommended to make a document even before you start writing the codes. This way your documentation is sure to be completed with the project and you would know precisely what code is to be […]

  5. […] is recommended to make a document even before you start writing the codes. This way your documentation is sure to be completed with the project and you would know precisely what code is to be […]

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

 
%d bloggers like this: