Tool sharing -- annotate C # documentation to generate. chm help documentation

Recently, I need to write a document for a previous project, but I don't know what to write at the moment. I just found a tool that can generate chm. So I just studied it and I feel pretty good, so I would like to share it with you. Well, there is not much nonsense. Let's implement it below.

Before proceeding, we should add one note: we generate help documents through the XML file generated by C # document annotations. Therefore, the first step is to generate an XML document:

Procedure: Open VS and create a project at Will (the console project is used here). Then, add the following content:

                              Name { ;                     Age { ;                                                Say( name,  + name +  +

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.

Download the tool from here:

Sandcastle: http://sandcastle.codeplex.com/. click downloadon the right.

Sandcastle Help File Builder: http://shfb.codeplex.com/

I found a VS plug-in the SHFB compressed package, so I plan to use VS for demonstration next. If you do not want to install this plug-in, you can run C: \ Program Files (x86) \ EWSoftware \ Sandcastle Help File Builder \ SandcastleBuilderGUI.exe, the results are the same

The most important thing is opening VS and creating a project:

It seems that there is nothing to summarize ....

References: http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html