ADB produces MSDN style documentation by reflecting and integrating XML Documentation Comments. ADB has the following key features:
1. Merge multi assemblies in a document;
2. Auto search XML Documentation Comments file of assemblies and their dependent assemblies;
3. Extent XML Documentation Comments Tags according to your own needs;
4. Develop custom document builder according to your own needs.

Instructions:

clip_image001_3.gif

Develop Custom Document Builder

1. Extent XML Documentation Comments Tag

The following is an example developing a custom document builder named “MyBuilder” that extent the following features:
(1) Extent a <image> tag for inserting images to the document;
(2) Insert a section named “Custom Section” to the type page and member page.

Steps:

(1) Click then menu Tool->Generate Custom Builder Solution->Extent XML Comments Tag, then input then information of the custom builder:

clip_image003_3.jpg


(2) Click “OK”, ADB will generate solution for you and open the solution;
(3) Open “MyBuilder.cs” file and input the following code:

MyBuilder.cs

code2.gif

MyBuilder.cs

(4) Build the solution and click the debug button to start ADB to debug the custom builder:

clip_image005_3.jpg

(5) Testing:

The following is the class and it’s comments for testing:

namespace ClassLibrary1
{
/// <summary>
/// Comments for Class1
/// </summary>
/// <CustomSection>
/// <image src='1.gif'/>
/// </CustomSection>
public class Class1
{
}
}

The document generated by MyBuilder:

clip_image007_3.jpg

(6) Let ADB load MyBuilder when starting:

Open the base directory of ADB and create a folder named “MyBuilder” in “builders”, then copy “MyBuilder.dll” and “MyBuilder.builder” to “MyBuilder” directory (as shown):

3.gif

4.png

Last edited Mar 6, 2009 at 5:51 PM by lucc, version 9