使用 Sandcastle 生成代码帮助文档
使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档。
1 下载并安装Sandcastle
Sandcastle下载地址为:http://sandcastle.codeplex.com/
2 下载并安装HTML Help Workshop
HTML Help Workshop可以用来生成chm文件,有的系统可能已经安装了HTML Help Workshop,HTML Help Workshop的默认安装路径为C:\Program Files (x86)\HTML Help Workshop,安装前可先到此目录下进行确认,若已经安装无须再安装。若需要重新安装最好使用默认安装路径。
HTML Help Workshop下载地址为:http://dl.pconline.com.cn/html_2/1/87/id=1917&pn=0.html
3 准备程序集和文档注释文件
Sandcastle生成帮助文档是基于代码编译后生成的程序集和文档注释文件来工作的。要想在代码编译过程中能生成文档注释文件,需要在VS中进行如下配置。
设置工程输出时包含XML文档文件,这样就会生成文档注释文件。
例:新建工程SandcastleExp,仅包含代码文件Student.cs,编译代码,在bin\Debug目录下的生成的SandcastleExp.dll和SandcastleExp.XML文件就是Sandcastle工具所需要的输入内容。
4 使用命令行方式操作Sandcastle生成帮助文档
将步骤3生成的SandcastleExp.dll和SandcastleExp.XML文件拷贝至C:\test文件夹(也可以是其他自建的任意文件夹),再将C:\Program Files (x86)\Sandcastle\Examples\Sandcastle(Sandcastle安装路径)下的批处理文件build_Sandcastle.bat拷贝至此文件夹。
使用cmd打开命令行窗口,进入该目录,输入命令:build_sandcastle.bat vs2005 SandcastleExp chm,回车。
成功执行后,会生成如下所示的chm文件。
注意:第一次安装Sandcastle后需要重启电脑,否则运行build_sandcastle.bat会出错。因为安装Sandcastle 后会创建一个系统环境变量 DXROOT,不重启电脑,该环境变量不会起作用。
3 使用图形用户界面的方式生成帮助文档
Sandcastle还提供了图形用户界面供用户操作。可执行文件为C:\Program Files (x86)\Sandcastle\Examples\Generic\SandcastleGui.exe。打开程序,并进行相关设置,界面如下。
点击“Build”后,在C:\Program Files (x86)\Sandcastle\Examples\test\vs2005\chm下生成chm帮助文件。
注意:必须使用管理员账户来运行程序。
在Win8环境下,需要修改C:\Program Files (x86)\Sandcastle\Examples\Generic\Generic.targets文件,具体修改内容如下:
<When Condition="Exists('$(ProgramFiles) (x86)')">
<PropertyGroup>
<ToolsPath>$(ProgramFiles(x86)) </ToolsPath>
</PropertyGroup>
</When>
将其中的“$(ProgramFiles(x86)) ”修改为“$(ProgramFiles) (x86) ”(注意:中间还有空格)否则程序无法生成chm文件。
关于代码注释规范,请自行网补。
转载自:http://blog.csdn.net/yl2isoft/article/details/18454115
程序员的基础教程:菜鸟程序员
转载于:https://www.cnblogs.com/guohu/p/5929226.html
使用 Sandcastle 生成代码帮助文档相关推荐
- 使用 Sandcastle 生成 chm 帮助文档
在上篇文章(编写并生成文档注释)中,我们已经了解了如何为类型和成员编写文档注释,以及如何生成相应的文档注释文件.在本文中,将简单地介绍如何使用 Sandcastle 生成 chm 文档. Sandca ...
- Sandcastle 生成.NET API文档的工具
Sandcastle是一个微软发布的工具,它通过反射程序集中的源代码以及添加代码中的XML注释来创建 MSDN形式的API文档.在CodePlex中刚发布了Sandcastle的一个新版本. 这个工具 ...
- phpdocumentor生成代码注释文档(linux)
1,默认安装lnmp环境(php7),默认pear安装 2, pear channel-discover pear.phpdoc.org pear install phpdoc/phpDocume ...
- FastAPI 自动生成的docs文档没法使用
FastAPI 自动生成的docs文档没法使用,当展开路径时候一直在转圈,具体就是这样 这个是由于swagger-ui 3.30.1 中的bug导致,具体bug可以看这里 我们可以通过在FastAPI ...
- Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档 简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...
- itextpdf api帮助文档_我开源了一个小工具,可以帮你轻松生成 SpringBoot API 文档...
前言 大家好,我叫叶大侠,一名独立开发者.这个文档工具是我17年的一个想法,当时还是在公司里面上班,负责App客户端的开发工作,当时后端童鞋写文档的意愿比较低,总是要等他们开发完接口,然后才在微信上沟 ...
- python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- Swagger+Spring mvc生成Restful接口文档
2019独角兽企业重金招聘Python工程师标准>>> Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端 ...
- 使用FastReport报表工具生成报表PDF文档
在我们开发某个系统的时候,客户总会提出一些特定的报表需求,固定的报表格式符合他们的业务处理需要,也贴合他们的工作场景,因此我们尽可能做出符合他们实际需要的报表,这样我们的系统会得到更好的认同感.本篇随 ...
最新文章
- Linux 服务器高并发调优实战
- 时间加减计算器_手机上的计算器这样也可以,太方便了,赶快转告家人朋友
- jca使用_使用JCA的密码学–提供者中的服务
- 逆袭之旅.DAY08东软实训.多态~
- Eclipse-Mybatis-generatorConfig.xml
- 怎么注册开通个人微信小程序
- ILSPY反编译工具下载代替收费的Reflector工具
- 单片机控制点阵字符显示及字模提取原理
- GitHub创建仓库导入项目
- 摩尔定律终结与科学大停滞
- 【蓝桥杯每日一练:小z的序列游戏-k】
- SIGMOD 2021 | 时间序列相关论文一览(附原文源码)
- 安乐高机器人图纸_乐高机器人搭法,乐高机器人 8547 搭建图纸 PDF文件
- 智能机器人无法智能对话_关于智能语音机器人使用中可能出现的问题
- springboot问题排解
- 定点乘法器优化---华为杯
- 蘑菇云「行空板Python入门教程」第八课:智慧农业可视化系统
- GoogleVR怎样在普通场景和VR场景之间进行切换
- shell 编程实例学习
- 乘积尾零的两种思路与解法