C # document Generation Tool

Sandcastle is an official Microsoft document generation tool. After NDoc development is stopped, it seems to be the only tool in this regard. It can generate a complete help document from the dll file and Its xml annotation file, and supports multiple generation formats (Helpe1x: chm, Helper2x: Hxs, Website, HelperView ), combined with the newly released Sandcastle Help File Builder visual tool, the entire generation process is very simple, and the SHFB tool looks very powerful, not only can you directly configure the attributes of the generated document, it also supports flexible extension settings to provide us with perfect. NET class library documentation becomes a possibility.
Let's take a look at the entire generation process step by step:

1. download the latest Sandcastle and install it.
2. Download the Sandcastle Help File Builder released this year from here.
3. After the installation is complete, create a project directly. The project properties will be directly opened in the main window. Here is the main configuration area of the generated document. First, add the source to generate the document. Right-click Documentation Sources in the project to add multiple file types (sln, proj, xml, dll, exe)
4. Set the main attributes.
FrameworkVersion: select the corresponding Framework version.
HelpFileFormat: select the format of the document to be generated. Note that the format selected here should be set in the corresponding area below.
Note that different compilation tools Helpe1x (chm) must be installed with Microsoft HTML Help for different formats, and Hxcomp must be installed for Helper2x (Hxs.
NamespaceSummaries: select the namespace to be generated and click open window. This is much better. You have to manually enter the command line or other tools before.
Lanugages: the language must be Chinese. This will automatically generate Chinese Characters in some documents.
CopyrightHref: copyright link
CopyrightText: copyrighted text
HelpTitle: document title
HtmlHelpName: name of the file generated
PresentationStyle: The supported formats include vs 2005 and Prototype.
OutputPath: generated path
Show Missing Tags: The following settings are set to True when the final version is generated as needed. Otherwise, a red prompt will appear in the document.
The page for completing the settings is as follows:

5. click the generate menu or button above to open the generate process interface. You can view some prompts and errors during the process. after the generation is complete, a document consistent with the MSDN style will come out:


6. You can also insert images and code into documents.
7. Code specifications are the most fundamental premise. You must add enough comments to the code.

Resource:
Sandcastle Help File Builder: http://shfb.codeplex.com/
SandcastleGUI: Another Sandcastle generation tool that http://www.inchl.nl/SandcastleGUI/ has been using before
Integrate documents into Visual Studio with Sandcastle and Help Integration Wizard
Http://www.cnblogs.com/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html

Read the full text

Category:Net view comments