Use sandcastle to create your class library documentation

1. required tools:

1. 1 sandcastle

Documentation compilers for Managed class libraries
Enabling Managed class library developers throughout the world to easily create accurate, informative documentation with a Common Look and Feel.

1.2 HTML Help Workshop and Microsoft. NET Framework Version 2.0

2. How to generate documents using sandcastle:

2.1 use sandcastlegui

2.2 Use command line

 

2.3 use docproject

3. Example

3.1 compile a class library first. Here I use the "XML document" example containing standard notes on msdn, which can be downloaded here.

3.2 open the downloaded project file and open xmlsample. CS, you can see the detailed explanations of various annotations (for more information, see the comments mark of the recommended documentation (C # programming guide )).

3.3 The docproject method is used here. After the docproject is installed, add a new project to the project,

The page appears. Select Settings all the way, click Next, and the project is displayed.

3.4 Before compiling a docproject, make sure that the class library of the document you want to generate is used to compile the XML file for output comments. For details, see generating an "XML document" in Visual Studio ".

3.5 compile the docproject project. Wait for a dozen minutes (it seems a little slow, even if the class library is small) and you will see the HTML and CHM documents under this project.

3.6 completed.

 

4. Related links:

4.1 sandcastle -- Documentation compilers for Managed class library

4.2 creating a CHM build using sandcastle

4.3 create a professional class library user document-sandcastle CTP release in December

4.4 sandcastle-official version of ndoc