制作Net程序的帮助文档--总结

一、工具的准备

目前,一般采用Sandcastle Help File Builder工具来制作.Net程序帮助文档,该工具主要是利用Xml文档里的信息以及DLL文件来生成完整的帮助文档。在Visual Studio中,使用三个/的注释内容才会被写入XML文档里,而两个/的注释是不会被写入的。

 

1、GhostDoc--VS代码注释插件

VS本身提供了自动生成XML注释的快键方式,比如在成员函数上面敲入///,VS会自动一种注释框架,但是这种注释里是不包含关于成员函数的说明文字,我们需要手动添加这些信息。有没有自动帮我们生成一些基本信息的呢?这个答案是肯定的,GhostDoc就是这么一款能帮助生成简单的说明文字的工具,它还能生成一些参数类型的附加说明。告诉你们一个好消息,GhostDoc是免费的,我们不用99就能将其带回家。

注意:GhostDoc所生成说明信息的准确率,是与我们的函数命名规范性有关,因此根据这准确率,在一定程度上也能反映出我们函数命名是否规范哦,当然我们也可以有自己的风格,不要太拘泥。

 

2、Sandcastle Help File Builder --文档生成工具

主角终于上场了,Sandcastle Help File Builder 的前身是微软的Sandcastle,Sandcastle之前被认为是NDoc的继承者,由于各种原因,Sandcastle现在已经停止维护了,取而代之的是Sandcastle Help File Builder ,它是由另外一位牛人在维护。

Sandcastle是通过提取dll文件及其xml注释文件来生成完整的帮助文档,同时还支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为我们提供完美的.NET类库文档成为一个可能。

如果想使用Sandcastle Help File Builder工具,我们还必须安装Sandcastle、Microsoft HTML Help。

 

必备软件下载地址:

 

可选

 

二、 制作帮助文档

制作过程,我就不写了,要充分利用已有资源,尽量不要重复做重复的事情,网上有教程已经将其写的很明白了。

 

说明一些注意事项。

事项一:

如果是C#的工程,需要把工程的属性-->生成-->Xml文档文件选中。如果是其他工程的话,只要属性里面包含Xml Document Fiel,我们就勾选上。如下图:

 

事项二:

如果生成的chm文件内容不显示,如下图

我这里出现这种情况主要是chm文件的路径中包含有“#”特殊字符所造成的,注意当chm文件的路径中含有“#”“%”等字符时,chm文件能够打开,但将无法显示。

此方法参照:chm电子书显示“此程序无法显示网页”的完美解决办法

时间: 2024-11-04 17:16:45

制作Net程序的帮助文档--总结的相关文章

CA证书应用二:制作带数字签名的PDF文档

接上期讲述了"CA证书应用一:Outlook发送邮件时,为邮件添加数字签名"之后,本期讲述如何给PDF文档添加数字签名. 大家都知道,如果想让一篇文档不再被修改,往往会制作为PDF格式.但是现在PDF文档很容易转化为Word格式,从而导致文档能进行第二次编辑.所以,如果想要确保PDF没有被别人修改,光制作成普通的PDF格式还不行,需要使用CA证书添加数字签名.具体实现方法如下: 一.安装Adobe Acrobat X Pro 制作PDF文档,当然需要先安装Adobe的PDF文档编辑工具

1.微信小程序的帮助文档地址和微信IDE工具下载

小程序这股风吹了有两个月了,本月9号也即将正式发布,可能大家还没有见过小程序的真容,那老彭就带大家一块了解一下.老彭打算做小程序系列, 微信小程序帮助文档中心. https://mp.weixin.qq.com/debug/wxadoc/dev/?t=201714 打开链接,结果一目了然,微信提供了简易教程和体验程序. 微信小程序开发工具下载 https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html?t=201714 微信这

一款写手册、电子书制作的工具。常用文档在线转换。

乐书是一款集多种优势功能于一身的高效办公工具,具有写书.写手册.制作电子书.多人在线云端协同办公.转换文档格式等功能.很多操作都可由鼠标拖拽直接完成,界面简单轻量,易于上手,并且无需下载任何软件,直接在网页上即可实现所有操作.同时您也可以通过"星标"功能,来标记重点的工作文本,以及您喜爱的作品. 使用乐书编辑文档.写手册.写书体验极佳,您可以通过乐书DIY自己作品的封面,还可以直接快速的将作品生成链接或二维码进行分享.乐书具有自动的云端在线保存的功能,帮您彻底消除文档丢失的烦恼,乐书也

通过程序校验xml文档学习笔记

校验xml文档,可以通过程序来校验,利用一段js代码即可. 各行代码的含义已经写出,运行这个html文件,检验如下xml代码: 结果如下: 如果xml文档出现错误: 结果如下: 其中,obj.async=false是关闭对象的异步加载模式,所谓异步是加载一句解释一句,同步是加载完成后再解释.

制作chm格式的帮助文档

学习java的人都用过jdk帮助文档,借助工具我们也可以自己生成chm格式的帮助文档, 原文:http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466441.html html格式的文档用着很不爽,1.页面的整洁度不行  2.没有索引功能 下面我就来介绍一款工具来快速将html文档转化为chm格式文档: 这里需要两款工具:1.htmlhelp.EXE  2.jd2chm.exe, 1. 一般情况下我们要先安装htmlhelp.EXE,

百度智能小程序_百度小程序注册指导文档

百度智能小程序注册 注册登录百度账号 注册地址:点击注册 登录地址:点击登录 使用百度App扫码登录 手机短信验证登录 百度账号密码登录 选择主体类型 主体类型:媒体.企业.政府.其他组织五种主体类型.主体类型说明: 媒体:报纸.杂志.电视.电台.通讯社.其他等: 企业:企业.个体工商户.企业相关品牌: 政府:国内.各级.各类政府机构.事业单位.具有行政职能的社会组织等: 其他组织:公共场馆.公益机构.学校.社团.民间组织等机构团体申请: 主体信息登记 不同类型的开发者所需的登记信息:包括主体信

微信小程序开发规范文档-注意事项

一个页面的数据如果需要被其它页面修改,则把这个页面的数据放入storage里. 目录结构符号 └ ┌ ┘ ┐ ┤ ├ ┴ ┬ ┼ │ ─ JS模块引入请使用import关键字,而非require,WXML引入模板用标签,WXSS使用@import语法,三者统一 所有方法和变量名称都使用小写camel模式,一般是动词+名词形式,尽量不要超过5个单词,如:getList,setBackImage 所有用到的常量的地方都使用全大写,下划线分隔的形式,如:EGG_CHE 使用this转换的地方,统一使用

应用程序写Xml文档

主要用到CreateElement.CreateTextNode.CreateComment.AppendChild.InsertAfter方法 代码如下: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 XmlDocument document = new XmlDocument();             document.Load("XmlReader.xml");             //Get

gSOAP 开发Web Service 客户端应用程序--摘自gSOAP文档

calc.wsdl 此案例使用c++开发 $>wsdl2h -o calc.h http://www.genivia.com/calc.wsdl $>soapcpp2 -i -C calc.h 这个时候你的文件应该有: 注意:去除.o结尾的文件和e.cpp剩下的文件就是用soapcpp2所产生的文件 $>touch e.cpp;vi e.cpp e.cpp 代码: $>g++ –c soapC.cpp --会产生soapC.o文件 $>g++ –c e.cpp --会产生e.