. NET project engineering to generate a project Help document Chm--sandcastle Tools

Sandcastle, created by Microsoft, is a tool used in the creation of MSDN-style documents. NET assembly and the associated XML comment file. The current version is released in June 2010. This is the command line and no GUI frontend, project management features, or like, you can find the automatic generation process in NDoc. Sandcastle's Help file generator, fills the blanks, provides the missing NDoc sample is the most commonly used feature, and provides a graphical and command-line-based tool to build an automated way to help files.

Prerequisite software: HtmlHelpWorkshop.exe online everywhere, if the machine has been installed on the need to ignore;

Here's how to get started with the software:

1, download the software, website: http://shfb.codeplex.com/;

Unzip to find folder Installresources; two installation packages found Sandcastle_jun_2010.msi;sandcastlehelpfilebuilder_1930.msi

2, start the installation, need to install two software (preferably by default installed to C + +)

Install Sandcastle_jun_2010.msi first;

Post-Installation Sandcastlehelpfilebuilder_1930.msi

3, after installation, in the program can find "Sandcastle Help file Builder GUI" execution files, run: (Inside has a new project-7)

Steps to use:

1. Click "File"--New project--pop-up dialog, enter project name, for example: AA, click Save

2, see AA works such as:

3, click on the "Right AA" below "documentation Source", right click Add, select our development project has compiled the DLL and XML file (Note: Project compilation must output XML file, the method is explained below)

4, configuration related properties;

①, Frameworkversion---Select the. NET version of the corresponding project (currently supported to 4.0)

②, Projectsummary---Project description-the compiled Chm--title property name

③, Htmlhelpname---the name of the output CHM file

④, Helptitle---file title description

⑤, Helpfileformat---Select HTMLHELP1

⑥, Language---The English (United States) is selected by default

⑦, Copyrighttext---your copyright notice

⑧, documentinheritedframeworkmembers----false true< will mask some of the inherited self-brought instructions >

⑨, documentinheritedmembers----false true< will mask some of the inherited self-brought instructions >

⑩, OutputPath---output CHM folder

Other properties can be defaulted ....

5, click "Bulid the Help File" button to compile the operation,

Explanation: Project build output XML file Operation---"Click on the project properties, pop-up dialog---generate--tick the output XML document file, the next compilation can output XML file

Reprinted by: http://blog.csdn.net/w3031213101/article/details/6659739

. NET project engineering to generate a project Help document Chm--sandcastle Tools