Use GhostDoc to automatically generate help documents for. NET projects

Development of the benefits of writing annotations is self-evident, not only to help team members quickly familiar with the code, but also convenient for their own maintenance. Exporting annotations to a CHM document is certainly easier to read.

. NET platform export annotation as a help document there are two main methods.
One is to build the XML document first through the configuration of the project properties, then sandcastle the XML into hhc,hhk,hhp three files through the file, and then compile the three files into a CHM through HTML Help Workshop. This method is cumbersome, time-consuming and laborious, the results of the export is not good to see, it seems very messy. A tutorial on the generation of this method look here: http://blog.csdn.net/chtnj/article/details/8278360
The other is automatically exported as a CHM document through the VS plug-in ghostdoc. The speed is slightly fast, the export is convenient and beautiful and easy to read. Here are some how to use GhostDoc to export. installation

The latest version of GhostDoc for VS can be found here:
Https://marketplace.visualstudio.com/items?itemName=sergeb.GhostDoc
Now is version 2017, if your computer installed on less than 2017, you may be prompted:

I'm a VS2015 here. Found on the CSDN Support 2015 version of the GhostDoc, link here:
http://download.csdn.net/detail/y276827893/9606175
No other version of the test, we can try to see if it can be used.

After downloading, you can install it one step at a while, before you install it, turn off vs. Use

Turn on vs when you are done, you can find GhostDoc under the Tools menu, and select "Build Help File":

The free version can only configure paths, and other items can be configured in a Personal edition, but the default is generally sufficient:

Click OK to wait for the build to automatically open the CHM folder, the effect is good: