使用 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

使用 Sandcastle 生成代码帮助文档的更多相关文章

  1. C# 自动生成代码API文档

    暂时没学会正规的转载style临时记录一下 NET中的规范标准注释(一) -- XML注释标签讲解 http://www.cnblogs.com/mq0036/p/3544264.html NET中的 ...

  2. phpdocumentor生成代码注释文档(linux)

    1,默认安装lnmp环境(php7),默认pear安装 2,   pear channel-discover pear.phpdoc.org pear install phpdoc/phpDocume ...

  3. Sandcastle Help File Builder 生成NET帮助文档

    Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcastle Sandcastle生成的输出结果具有 ...

  4. 使用SandCastle创建.Net帮助文档

    使用SandCastle创建.Net帮助文档 引用自:http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html Sandcas ...

  5. Swagger+Spring mvc生成Restful接口文档

    简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

  6. GhostDoc:生成.NET API文档的工具 (帮忙文档)

    在 Sandcastle:生成.NET API文档的工具 (帮忙文档) 后提供另一个生成API文档的工具.   1) 准备工作 安装GhostDoc Proc. 收费的哦.... 这个工具的优势是不像 ...

  7. 使用jsdoc-toolkit来自动生成js api文档

    近来前端组小盆友开发的类库越来越多,很多情况下彼此不知道写了些什么方法,为了更好的合作提高工作效率,找了个比较好的api文档生成方法.使用jsdoc-toolkit来自动生成js api文档. 一.  ...

  8. ASP.NET API Helper Page 创建并生成相关帮助文档

    创建API项目 修改原工程文件,该行为是为了避免和引入第三方API工程文件冲突 修改发布设置 引入需要生成文档的相关文件,将第三方API依赖的相关文件(XML文件非常重要,是注释显示的关键),复制到文 ...

  9. Android开发——使用Jword生成本地word文档

    本文主要介绍如何使用Jword生成本地word文档,这里涉及到Jword的使用技巧,本文给出相应的代码,需要的朋友可以参考下. 为什么使用Jword呢?因为IText .Freemark在安卓平台上压 ...

随机推荐

  1. 如何获取TypedArray?

    当我们需要自定义控件的时候经常会使用到TypedArray这个类,使用完之后必须调用recycler()函数.... 但是如何获取呢? 有如下几个方式: context(实际最后调用的是context ...

  2. Android IOS WebRTC 音视频开发总结(八十六)-- WebRTC中RTP/RTCP协议实现分析

    本文主要介绍WebRTC中的RTP/RTCP协议,作者:weizhenwei ,文章最早发表在编风网,微信ID:befoio 支持原创,转载必须注明出处,欢迎关注我的微信公众号blacker(微信ID ...

  3. Spring boot开发过程遇到的一些小问题

    1.无法将yml文件自动注入到对应的类的实例中去: pom.xml文件里没有加如下依赖 <dependency> <groupId>org.springframework.bo ...

  4. oracle驱动问题

    转载   http://sosuny.iteye.com/blog/806390

  5. asp.net MVC上传图片完整方法

    图片上传 自动创建文件夹并重命名(带缩略图) 后台: [HttpPost] public ActionResult WanSell_UploadPicture(ProductGalleryModels ...

  6. 让window.close不提示:您查看的网页正在试图关闭窗口。是否关闭此窗口?

    正常来说,当我们调用window.close来关闭从地址栏中打开的窗口时,IE会弹出提示说:您查看的网页正在试图关闭窗口,是否关闭此窗口? 你可以将window.close替换成下边的脚本,然后再测试 ...

  7. Redis性能点

    AliRedis是来自阿里巴巴的基于Redis改造的缓存产品,目前还未开源.网上只能搜到这么一篇资料<AliRedis单机180w QPS, 8台服务器构建1000w QPS Cache集群&g ...

  8. Mac升级到Yosemite后默认的php版本不支持imagetfftext函数问题解决

    Mac升级到yosemite后,php也自动升级,运行项目的时候发现后台验证码显示不出来.调试一下发现imagetfftext这个函数不存在,应该gd没有安装完全,因为Mac上的php实现系统自带的, ...

  9. ---Shell的数组遍历

    1.  一一读入:  read -a A < <(echo a b c d e f g) 2. 遍历输出

  10. java -json()

    json-lib和org.json的使用几乎是相同的,我总结出的区别有两点: 两种包 1. List集合转换成json方法 List list = new ArrayList(); list.add( ...