C # CHM help document Generation Tool

C # CHM help document generation tool-sandcastle
Sandcastle was used to generate a chm format document for our development team to standardize documents and facilitate communication.

1. download.
I found two types of sandcastle available for download: one is the official sandcastle and the other is the sandcastlegui (GUI ).
The first one must be installed, and then download a sandcastlegui, which can be directly used as follows:
Sandcastle: http://www.microsoft.com/downloads/details.aspx? Familyid = E82EA71D-DA89-42EE-A715-696E3A4873B2 & displaylang = EN (can also be downloaded from codeplex)
Sandcastlegui
It is important to note that the http://www.inchl.net/SandcastleGUI/ does not provide direct download, but is confirmed by mail before the download.
Here are the documents and software interfaces generated using sandcastlegui. Are they very beautiful?

Ii. Generate XML documents.
Right-click the vs project and choose Properties. In the displayed dialog box, select build and check before XML documentation. In this way, all programs compiled later will come with an XML file, which is an important file for generating help documents.

3. Add instructions in the program. The method is as follows:
Namespace danganguanli. logsystem
{
/// <Summary>
/// Log-related operation set, which is implemented through log4net.
/// <Remarks> class diagram: <br/>
///
/// </Remarks>
/// </Summary>
Public class loghelper
{
/// <Summary>
/// Create a loginfo Log Type
/// </Summary>
Public static readonly log4net. ilog loginfo = log4net. logmanager. getlogger ("loginfo ");

/// <Summary>
/// Not implemented
/// </Summary>
Private Static void systemlog ()
{
}
/// <Summary>
/// Initial log4net settings
/// </Summary>
Public static void setconfig ()
{
Log4net. config. xmlconfigurator. Configure ();
}

....
Note the following:
/// <Remarks> class diagram: <br/>
///
/// </Remarks>
After the preceding sections are added, you can add class digraphs when generating CHM documents ). Loghelper.png is the file saved after the class graph is manually exported.

4. Generate the CHM document.
1. Compile the program first, and find the generated. dll and. xml files from the bin directory (Note: The file name is the same. If the. xml file is not displayed, it indicates that the second step is not completed. Please do it again .) And the referenced dynamic library are all copied to a separate folder, such as the C:/document folder.
2. Copy the sandcastlegui.exe file to this folder and run it (as shown in the running interface ).
3. Add or select relevant content as prompted.
4. Click the start documenting button to view the generated CHM file in a few minutes.