Help documentation for making net programs--Summary

First, the preparation of tools

Currently, the Sandcastle Help file Builder tool is commonly used to create a. NET program assistance document that uses information from an XML document and DLL files to generate a complete help document. In Visual Studio, the use of three/comment content will be written to the XML document, and two/comments will not be written.

• Suggestions: XML comment tags explained

1. Ghostdoc--vs Code Comment Plugin

VS itself provides a quick-key way to generate XML annotations automatically, such as typing///,vs on member functions automatically a comment frame, but this comment does not contain explanatory text about member functions, and we need to add this information manually. Does it automatically help us generate some basic information? The answer is yes, GhostDoc is a tool that can help generate simple explanatory text, and it can generate additional descriptions of some parameter types. To tell you a good news, GhostDoc is free, we can take it home without 99.

Note: The accuracy of the description information generated by GhostDoc is related to our function naming standard, so according to this accuracy rate, to a certain extent can also reflect the function of our naming norms Oh, of course, we can also have their own style, not too rigidly.

• Use of GhostDoc http://www.cnblogs.com/zpq521/archive/2011/02/21/1959389.html
• Ghostdoc:http://submain.com/products/ghostdoc.aspx

2. Sandcastle Help file Builder--Document generation tool

The protagonist finally played, Sandcastle help File Builder predecessor is Microsoft's Sandcastle,sandcastle was considered to be NDoc successor, for various reasons, Sandcastle has now stopped maintenance, Instead, Sandcastle help File Builder, which is maintained by another bull man.

Sandcastle generates a complete help document by extracting the DLL file and its XML comment file, as well as supporting a variety of build formats (Helpe1x:chm, HELPER2X:HXS, Website,helperview), Combined with the newly released sandcastle help File Builder Visualizer, the entire build process is simple, and the SHFB tool looks powerful not only to directly configure the individual properties of the generated document, but also to support very flexible extension settings that provide us with the perfect. NET class Library document becomes a possibility.

If you want to use the Sandcastle Help File Builder tool, we must also install Sandcastle, Microsoft HTML help.

Software Prerequisites:

• Sandcastle:http://www.codeplex.com/sandcastle
• Sandcastle Help File builder:http://shfb.codeplex.com/
• Microsoft HTML help:http://msdn.microsoft.com/en-us/library/ms669985 (vs.85). aspx

Options available

• sandcastlegui:http://www.inchl.nl/sandcastlegui/(another Sandcastle build tool that has been used before)
• Integrate documents into visual Studio with Sandcastle and help Integration Wizard

Second, the production of help documents

Production process, I will not write, to make full use of existing resources, try not to repeat things, the online tutorial has been written it very clear.

• Make Help document reference:. NET programs help document making
• Sandcastle (Sandcastle help File Builder) C # document Generation tool-vb.net Note document Builder

Describe some considerations.

Item One:

If it's a C # project, you'll need to select the project's properties--Generate a-->xml document file. If it is another project, as long as the attribute contains XML Document Fiel, we tick. Such as:

Item Two:

If the contents of the generated CHM file are not displayed, such as

I'm here. This situation is mainly caused by a "#" special character in the path of the CHM file, note that the CHM file can be opened when the path of the CHM file contains characters such as "#" and "%", but it will not be displayed.

This method references: CHM ebook shows the perfect solution for "This program cannot display Web page"

Help documentation for making net programs--Summary