Sandcastle Help file Builder documentation

1. Overview

the application can be based on the assembly that we compiled or VS the project automatically generates the appropriate help documentation.

2. Installation Instructions

Download the latest installation package from Https://github.com/EWSoftware/SHFB/releases, unzip to folder, run SandcastleInstaller.exe for installation.

3. New Project

After the installation is complete, open the application, File->new Project, enter the file name, click Save, the following screen appears:

4. Add source Files

Right-click the documentation Sources node in Project Explorer and select Add Documentation Sources ...

In the dialog box that appears, select the assembly or VS project for which you want to generate the description document, you must select the VS generated XML document (as shown in:)

The next step is to add a reference assembly. Reference assemblies are assemblies that are associated with documentation sources, and many of the inherited classes or member information in documentation sources need to be supplied by a reference assembly. However, referencing an assembly does not generate a description document (you can not add it).

5. Property Description

Build property (shown):

On the left side of the Build property page is the format for the build Help document, which you can select first.

On the right side of the Build property page, other settings include the framework version, the name of the log file, and more

Help file property (for example):

The settings that are noted for this attribute are:

Help title: Caption of the helper document

Help file name: Names of helper documents

Help file language: Language of the helper document

Syntax Filters: Syntax filter, based on which language syntax to generate the Help document

Visibility attributes (such as):

is equivalent to the permission control of the generated help document, in general, we will block out the private field properties and methods.

Missing tags properties (such as):

The Missing tags property primarily sets which XML tags can be generated into the help documentation, such as: If the namespace has no comments, the namespace documentation option should not be checked

Path property (for example):

The Help content Output path option primarily sets the path that is generated by the helper document

5. Generate the Help document

Click Build Project on the Documentation option in the menu bar or click on the toolbar's build project to build the Help document, and if an error occurs, you can toggle the display interface in the Output tab to see the error message

Appendix:

For a detailed documentation of Sandcastle help File Builder, refer to

Http://shfb.codeplex.com/documentation

If you want to refer to the source code of Sandcastle help File Builder, visit

Http://shfb.codeplex.com/SourceControl/latest#ReadMe.txt

Sandcastle Help file Builder documentation