当前位置: 首页 > 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的函数
  • 安沃广告问题
  • 分享一款快速APP功能测试工具
  • Angular 响应式表单 基础例子
  • Druid 在有赞的实践
  • ES6 ...操作符
  • HTTP中GET与POST的区别 99%的错误认识
  • java概述
  • JS变量作用域
  • Laravel Telescope:优雅的应用调试工具
  • NSTimer学习笔记
  • Redis 懒删除(lazy free)简史
  • swift基础之_对象 实例方法 对象方法。
  • Vue 动态创建 component
  • Zepto.js源码学习之二
  • 海量大数据大屏分析展示一步到位:DataWorks数据服务+MaxCompute Lightning对接DataV最佳实践...
  • 利用DataURL技术在网页上显示图片
  • 延迟脚本的方式
  • 验证码识别技术——15分钟带你突破各种复杂不定长验证码
  • #LLM入门|Prompt#1.7_文本拓展_Expanding
  • #LLM入门|Prompt#1.8_聊天机器人_Chatbot
  • #我与Java虚拟机的故事#连载04:一本让自己没面子的书
  • #我与Java虚拟机的故事#连载06:收获颇多的经典之作
  • (2)Java 简介
  • (6)【Python/机器学习/深度学习】Machine-Learning模型与算法应用—使用Adaboost建模及工作环境下的数据分析整理
  • (8)Linux使用C语言读取proc/stat等cpu使用数据
  • (android 地图实战开发)3 在地图上显示当前位置和自定义银行位置
  • (Matlab)基于蝙蝠算法实现电力系统经济调度
  • (超详细)语音信号处理之特征提取
  • (力扣)1314.矩阵区域和
  • (免费领源码)python+django+mysql线上兼职平台系统83320-计算机毕业设计项目选题推荐
  • (十八)devops持续集成开发——使用docker安装部署jenkins流水线服务
  • (四)docker:为mysql和java jar运行环境创建同一网络,容器互联
  • (已解决)vue+element-ui实现个人中心,仿照原神
  • (转)JVM内存分配 -Xms128m -Xmx512m -XX:PermSize=128m -XX:MaxPermSize=512m
  • (转)shell中括号的特殊用法 linux if多条件判断
  • (转载)VS2010/MFC编程入门之三十四(菜单:VS2010菜单资源详解)
  • (转载)跟我一起学习VIM - The Life Changing Editor
  • (转载)利用webkit抓取动态网页和链接
  • .cfg\.dat\.mak(持续补充)
  • .NET 6 Mysql Canal (CDC 增量同步,捕获变更数据) 案例版
  • .Net 6.0 处理跨域的方式