NDoc to Sandcastle - Generate MSDN Style Documentation and Help Files Based on XML Comments in your .NET Code

NDoc was the defacto standard for generating MSDN style documentation based on XML comments in your .NET 1.1 code, but the open source developer has no plans to create a new version of NDoc that supports .NET 2.0.

Microsoft has stepped in an provided SandCastle, which allows you to generate documentation and help files based on your .NET 2.0 code. It is still in CTP, but has the following features:

“Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features:

  • Works with or without authored comments
  • Supports Generics and .NET Framework 2.0
  • Sandcastle has 2 main components (MrefBuilder and Build Assembler)
  • MrefBuilder generates reflection xml file for Build Assembler
  • Build Assembler includes syntax generation, transformation..etc
  • Sandcastle is used internally to build .Net Framework documentation“

There is a FAQ for Sandcastle.

Here are a couple of CodePlex Projects to help with Sandcastle:

Download Sandcastle here.

Source: David Hayden ( Florida ASP.NET Developer )

Filed: Must Have .NET Developer Tools

 

posted on Sunday, August 20, 2006 10:10 AM

Main

News

Green Tea

.NET Development

Enterprise Library

Patterns & Practices