使用SandCastle制作chm文档

SandCastle是微软官方的文档生成工具,功能很强大,这里主要介绍使用SandCastle的Visual Studio插件生成chm文档的方法(当然也可以通过Sandcastle Help File Builder,具体可以自行研究)。

3.jpg

首先放上自己下载的Sandcastle相关工具的下载地址,也可以自己去下载最新版。
链接: http://pan.baidu.com/s/1i4BubC5 密码: w45a

打开SandcastleInstaller安装相关工具。

完成Sandcastle的开发环境后,接下来需要通过C#代码注释生成xml文档

1.jpg

打开自己的项目,以unity项目为例,首先右键需要导出文档的项目属性,这里选择Assembly-CSharp程序集,在Build页面勾选XML documentation file。

2.jpg

直接Build,在对应目录下找到Assembly-CSharp.dll和Assembly-CSharp.xml

接下来在vs中新建项目,如果之前环境搭建成功,则可以选则Sandcastle Help File Builder Project,

4.jpg

之后右键Documentation Sources添加文档来源,选择刚刚生成的xml文件(保证生成的dll和xml在同一文件夹,会自动将dll也加入)

之后可以定制文档的首界面:Welcome.aml,或者加入新的定制界面:编辑ContentLayout.content

另外如果生成的文档只包含C#的话需要右键项目属性,将C++ VB F#等其他语言勾选去掉。

一切准备就绪后就可以生成文档了。

5.jpg
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,951评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,381评论 25 708
  • 1、特殊文件夹(unity doc : Special Folders) Unity工程根目录下,有三个特殊文件夹...
    小飞不会飞_阅读 6,411评论 2 27
  • 大家好,我是“江湖”小学生,枝上白羽。今天我给大家带来的是《加勒比海盗》的观影感悟,希望能给大家不一样的江湖体验。...
    枝上白羽阅读 452评论 3 3
  • 我要旅行了, 风来找我, 又像顽犬, 钻入篱笆, 先我而去森林。 要预订, 藏蓝色天空, 大片的絮云落地, 我在行...
    易安阅读 332评论 0 4