Sandcastle is Microsoft's Official document generation tool, which seems to be the only tool in this area after NDoc development has stopped. It can generate complete help documents from DLL files and their XML comment files, supporting multiple generation formats (Helpe1x:chm, HELPER2X:HXS, Website,helperview), combined with the newly released sandcastle helps file Builder visualizer, the entire build process is very simple, and the SHFB tool looks very powerful, not only can directly configure the various properties of the generated document, but also support very flexible extension settings, to provide us with perfect. NET class Library document becomes a possibility.
Http://sandcastle.codeplex.com/documentation
Introduction to the Generating CHM documentation tool
Sandcastle is Microsoft's Official document generation tool, which seems to be the only tool in this area after NDoc development has stopped. It can generate complete help documents from DLL files and their XML comment files, supporting multiple generation formats (Helpe1x:chm, HELPER2X:HXS, Website,helperview), combined with the newly released sandcastle helps file Builder visualizer, the entire build process is very simple, and the SHFB tool looks very powerful, not only can directly configure the various properties of the generated document, but also support very flexible extension settings, to provide us with perfect. NET class Library document becomes a possibility.
Download the tool from here:
sandcastle:http://sandcastle.codeplex.com/, click on the right side of the download we all know.
Sandcastle Help File builder:http://shfb.codeplex.com/
I found a vs plugin in SHFB's compression package, so I'm going to use vs to demonstrate that if you don't want to install the plugin, you can run C:\Program Files (x86) \ewsoftware\sandcastle help File Builder \sandcastlebuildergui.exe This program, the results are the same
To generate a CHM document
Come on, open vs, New project:
Click OK, the project structure on the right:
Choose Contentlayout.content, look to the left, there are some document properties and version numbers and other information, but we do not use here, so delete. If it's okay to keep it, it's just a few more lines in the head when the document is generated, and interested friends can continue to study.
Select the assembly for which you want to generate the document (the corresponding XML is automatically added).
Right-click the project selection properties:
So far there is nothing but the wind. So where is the east wind? Very simple, build the project. If there is no error in the build process, you will see it under the Help folder in the project directory:
Open the test document:
? generate CHM Document Tool-Sandcastle-from the network