在Visual Studio下编程,有两个很方便的生成chm帮助文档的工具。它们就是Sandcastle Help File Builder 和Sandcastle。Sandcastle Help File Builder简称SHFB,它可以生成MSDN风格的代码文档,而Scandcastle是微软为了配合SHFB而开发的一个VS帮助文档控件,使用这两个工具就可以制造精美的Help文件了。下面,主要介绍.Net中Help文件的制作。
1. 下载Sandcastle Help File Builder并安装,
个人地址: /s/1kTqsw43
官网地址:/SHFB
2. 下载Sandcastle并安装,
个人地址:/s/1mgkkICS
官网地址:/Sandcastle
3. 操作方法:
3.1)新建一个C#项目,名称为World右击【World】/【属性】—》在【生成】选项卡,勾选[√] XML文档文件,如图(1)所示:
图(1)在【属性】/【生成】选项卡里,勾选“XML文档文件”
3.2)在类名、方法名前,输入相应的注释,一般以///开头,如下所示:
using System;using System.Collections.Generic;using System.Linq;using System.Text;namespace world{/// <summary>/// Helloworld类/// </summary>public class Class1{/// <summary>/// 返回一个字符串/// </summary>/// <returns>字符串</returns>public string HelloWorld(){return "欢迎来到Helloworld世界!";}/// <summary>/// 根据参数,返回一个字符串/// </summary>/// <param name="str">参数</param>/// <returns>字符串</returns>/// <example>string str=HelloWorld("abc");</example>public string HelloWorld(string str){return str;}}}
3.3)点击VS工具栏上的“生成”按钮,以生成XML文件,然后打开Sandcastle Help File Builder,点击“File”–>New Project ,名称为:Test4,如图(2)所示:
图(2)新建一个Scandcastle工程:Test4
3.5)添加xml文件,并设置Test4的帮助文档标题名称和chm文件名称。
a) 右击工程Test4下的“Document Source”–》Add Document Source—>找到 world.XML文件–》点击“打开”,如图(3)所示:
图(3)添加对应的 .XML文件
b)设置标题名称 和文档名称,并点击“编译”按钮,如图(4)所示:
Help title:(帮助文档的标题名称) World_Chm_1.0
Help file name :(chm文件名称) World
图(6)设置chm文档标题和存储文件名称,并点击“编译”按钮
3.7)编译大概等两三分钟之后,就会将.xml文件转化为.chm文件。如图(7)、图(8)所示:
图(8).chm存储的路径
生成.chm文件的效果如下:
图(9)生成的World_Chm_1.0.chm文件
参考文献地址:/jeff377/archive//11/15/1334233.html
/luckly-hf/p/3300815.html
/ASPNET/archive//07/09/1774459.html