当前位置: 首页 > news >正文

.Net程序帮助文档制作

一,准备工作

1,首先介绍一款VS的代码注释插件GhostDoc

你也许认为我们在代码中敲入///就能自动生成xml注释,但这种注释是没有说明文字的。而GhostDoc可以生成一些简单的说明文字,如果你的函数命名很规范的话,它生成的函数描述会很准确。并且它还能生成一些参数类型的附加说明。在你想生成代码注释的地方按下Ctrl+Shift+D,它就会自动帮你生成xml注释,非常方便。
下载地址:http://submain.com/products/ghostdoc.aspx 

GhostDoc毕竟是个免费版,功能也有限,作为程序员有必要掌握一些常用的用于生成xml注释的标签。
可以参考园子里的这篇文章,写的很好 http://www.cnblogs.com/zhangziqiu/archive/2009/01/23/1380416.html

2,在VS中生成帮助文档的xml文件

如果是C#的工程,需要把工程的Property-->Build-->Xml Document Fiel选中,并为生成的xml文件取一个名字,
这样,我们编译的时候,就会自动生成代码注释xml文件了。需要注意一点,三个/的注释才会生成,两个/的注释是不会生成的。

3,下载帮助文档的生成工具

以前微软维护了一个叫Sandcastle的生成工具,被认为是NDoc的继承者。不过现在Sandcastle已经停止维护了,被移交到了这里
http://shfb.codeplex.com/    由另外一个牛人进行维护,命名为Sandcastle Help File Builder,大家可以去下载这个工具。
下面我们就用最新的Sandcastle Help File Builder来制作一个简单的帮助文档。

二,制作帮助文档

1,在开始菜单中打开Sandcastle Help File Builder GUI这个软件,生成一个新工程。

image

2,导入我们的xml和对应的dll或exe文件

找到最右边的Project Explorer-->Documentation source,点右键,可以添加对应的带有注释的xml文件,添加xml文件的同时,会把同名的dll或exe文件一并导入。
但是我们也可以选择导入工程文件(.csproj),这样生成帮助文档的过程中,用到其他参照的dll会自动解决,省去了很多的麻烦。
我第一次用的是选dll这种方式,结果发现一些参照dll找不到,导致生成不成功,然后采用选择工程文件这种方式一切就OK了。

image

3,导入必要的文件后,我们还需要对要生成的chm文件做一些设置。

image 

4,查看生成的chm文件

默认的生成文件放在了My Document下面。比如我生成的文件放在了My Document-->Help-->MyFirstHelperFile.chm位置 。

下面的图对应于上图中每个设置部分的作用效果。

image

image

到此,一个简单的chm帮助文件就做好了。这个工具还可以添加一些额外的图片,txt,html等内容一起生成更加丰富的chm文件。
由于我目前用不到这些功能,没有进一步研究

Technorati Tags: .Net, 帮助文档

转载于:https://www.cnblogs.com/xiashengwang/p/3837659.html

相关文章:

  • MySQL备份与恢复常用方法总结(mysqldump/xtrabackup/lvm快照备份/逻辑备份与恢复/二进制日志及时点恢复)...
  • samba服务的安装与配置
  • 关于sqlmap的一些命令
  • Nothing2
  • Download Images Using NSURLConnection
  • 维基百科上—数据仓库、数据挖掘、OLAP三者之间的区别
  • 【翻译笔记】在大集合中用MapReduce处理成对文档相似性
  • SCOI2013 多项式的运算 (BZOJ 3323)
  • iframe的使用小贴士
  • [转]操作复杂对象结构——访问者模式
  • 使用JDK开发Servlet程序
  • 程序员,你需要大量地阅读
  • map我觉得非水题-hdu-4329
  • php一些不是很常用的操作mysql的函数
  • 安沃广告问题
  • 【跃迁之路】【669天】程序员高效学习方法论探索系列(实验阶段426-2018.12.13)...
  • 230. Kth Smallest Element in a BST
  • CSS3 变换
  • Docker容器管理
  • Docker下部署自己的LNMP工作环境
  • Git学习与使用心得(1)—— 初始化
  • Laravel Mix运行时关于es2015报错解决方案
  • Objective-C 中关联引用的概念
  • PyCharm搭建GO开发环境(GO语言学习第1课)
  • SAP云平台运行环境Cloud Foundry和Neo的区别
  • 从伪并行的 Python 多线程说起
  • 对象引论
  • 浮现式设计
  • 软件开发学习的5大技巧,你知道吗?
  • 数据可视化之 Sankey 桑基图的实现
  • 推荐一款sublime text 3 支持JSX和es201x 代码格式化的插件
  • ​软考-高级-系统架构设计师教程(清华第2版)【第20章 系统架构设计师论文写作要点(P717~728)-思维导图】​
  • #if和#ifdef区别
  • #Linux(帮助手册)
  • (02)Hive SQL编译成MapReduce任务的过程
  • (cos^2 X)的定积分,求积分 ∫sin^2(x) dx
  • (Redis使用系列) Springboot 实现Redis 同数据源动态切换db 八
  • (未解决)macOS matplotlib 中文是方框
  • (转)fock函数详解
  • (最优化理论与方法)第二章最优化所需基础知识-第三节:重要凸集举例
  • .net core webapi 部署iis_一键部署VS插件:让.NET开发者更幸福
  • .netcore如何运行环境安装到Linux服务器
  • .net下的富文本编辑器FCKeditor的配置方法
  • .NET中使用Redis (二)
  • /etc/fstab和/etc/mtab的区别
  • @Valid和@NotNull字段校验使用
  • [ CTF ] WriteUp-2022年春秋杯网络安全联赛-冬季赛
  • [ vulhub漏洞复现篇 ] AppWeb认证绕过漏洞(CVE-2018-8715)
  • [ vulhub漏洞复现篇 ] GhostScript 沙箱绕过(任意命令执行)漏洞CVE-2019-6116
  • [BIZ] - 1.金融交易系统特点
  • [Bzoj4722]由乃(线段树好题)(倍增处理模数小快速幂)
  • [CentOs7]搭建ftp服务器(2)——添加用户
  • [EWS]查找 文件夹
  • [FT]chatglm2微调
  • [gdc19]《战神4》中的全局光照技术