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