Four sandcastle methods to generate C#.net help class Help documentation

Reading directory (content)

• Method One, Visual studio new documentation Build help document
• First, download
• Second, installation
• Third, set
• V. Generation
• Method Two, cmd generation help document
• Method Three, Sandcastlebuildergui
• Method Four, Sandcastle help File Builder Visualizer

Method One, Visual studio new documentation Build help document

In the previous period of time in the online collection and their usual work summary of "dry, more comprehensive c#.net public help class", finishing upload GitHub after uploading I think, since it is a help class, there must be a help document so think of Sandcastle, Sandcastle is Microsoft's official tool for generating help documents.

It can be combined with the DLL and XML comment files generated by Microsoft Visual Studio to generate a complete help document.

Combined with the visualizer sandcastle help File Builder, it is straightforward and can generate descriptions of various properties.

Support Helpe1x:chm, Helper2x:hxs, Website,helperview and many other formats and flexible and powerful, let's look at how to use Sandcastle to generate CHM documents.

First, download

First we go to CodePlex download sandcastle, Address: http://sandcastle.codeplex.com/

Then download Sandcastle help File Builder, Address: http://shfb.codeplex.com/, click on the right download download.

Second, installation

Sandcastle, direct next will do, Sandcastle help File Builder to say is, in Maml Schema IntelliSense for Visual Studio to the VS install plug-in when must tick, Otherwise, you will not have this option when creating a new project.

Third, set

Set the XML document file in the build here, save, and compile the bin\debug in your project directory to see the generated XML file.

Iv. New Project Documentation

Start by creating a new documentation project, which is the reason to check for VS when installing Sandcastle help File Builder. If it is not checked, this option is not available when you create a new one here.

Then tick the DLL and XML file that you have just generated, and right-click Properties such as Write on the title. Compile the build. One thing to note here is that there may be an error (Shfb:error be0037:could not find the path the the the the HTML Help 1 compiler. See the "Error number topic in the" for details.), is not installed Microsoft HTML Help, of course, you can skip this step after installation.

If Microsoft HTML Help is not installed, we go to https://www.microsoft.com/en-us/download/details.aspx?id=21138 to download Microsoft HTML Help then install.

V. Generation

If there is no error, generate directly, and then help from our project directory will be able to see the generated assistance document.

is not very simple. This allows us to generate the help documentation for the previous help class. I'll also describe several ways to generate help documents.

Method Two, cmd generation help document

With Sandcastle and sandcastle help File Builder installed,

Copy the Common.Utility.dll and Common.Utility.xml that we generated in step three to C:\Program Files (x86) \sandcastle\examples\ Sandcastle (Sandcastle installation path) below.

This method is a batch method, then we open cmd, enter Build_sandcastle.bat vs2005 common.utility carriage return, and then batch processing.

We will see a lot of folders generated in this directory, if the process is not error, we will see in the CHM folder we generated the Help document.

Method Three, Sandcastlebuildergui

Based on the above settings, we then introduce Common.Utility.dll and Common.Utility.xml, which can be generated. Related Settings Reference: http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html

Method Four, Sandcastle help File Builder Visualizer

Graphical operator interface via Sandcastle. Open the following interface under C:\Program Files (x86) \sandcastle\examples\generic\sandcastlegui.exe.

Follow the relevant settings on the diagram and click the Build button. It is more convenient and concise to generate help documents.

Of course the premise is also to generate Common.Utility.dll and Common.Utility.xml under the circumstances.

The help document is generated in the four ways. At this point the C#.net help class is over.

GitHub Address: Https://github.com/Jimmey-Jiang/Common.Utility

Original link: https://www.cnblogs.com/anyushengcms/p/7682501.html

Four sandcastle methods to generate C#.net help class Help documentation