You are here: Documenting Your Class Library with Microsoft® Sandcastle

Documenting Your Class Library with Microsoft® Sandcastle

Microsoft's Sandcastle utility automatically creates MSDN formatted reference documentation from .NET assemblies and XML comment files. This makes it possible for you to document a class library — plus add narrative information — quickly and efficiently. Doc-To-Help integrates Sandcastle's XML output into your projects, automatically creating topics, index, TOC, and other Help elements. With this information added to your project, you can edit/add your own topics, and easily link to namespaces.

With this plug-in you can generate any output from Sandcastle-generated content, automatically add reference sections to your documentation using Microsoft utilities, and enjoy automatic standard MSDN formatting.

Documenter for .NET is still included with Doc-To-Help if you have older projects you’d like to maintain.



Creating a Project with Sandcastle

Converting Doc-to-Help Documenter for .NET projects to Doc-to-Help Sandcastle projects

CodeBlock and PostTransform components

D2HML hot spots in XML comments in source code

XSLT transformation of the source code comments XML

Exclude elements without description

Special styles to easily create links from narrative parts to the reference part

Source template and the toolbar "Doc-To-Help - Sandcastle"