下面介绍开始如何使用该软件:
1、下载该软件,网址:http://shfb.codeplex.com/;
解压找到文件夹InstallResources;可找到两个安装包Sandcastle_Jun_2010.msi;SandcastleHelpFileBuilder_1930.msi
2、开始安装,需要装两个软件(最好默认安装到C:\下)
先安装Sandcastle_Jun_2010.msi;
后安装SandcastleHelpFileBuilder_1930.msi
3、安装完毕后,在程序中可以找到“Sandcastle Help File Builder GUI”执行文件,运行:(里面已经新建了一个工程-7)
使用步骤:
1、点击“File”--> New Project -->弹出对话框,输入工程名称,比如:AA,点击保存
2、见AA工程如下图:
3、
选择项目属性-勾选xml文档文件。
点击“右边AA”下面“Documentation Source”,点击右键Add,选择我们开发项目已经编译好的dll和xml文件(注意:项目编译 必须输出 xml文件,方法见下面解说)
4、配置相关属性;
①、FrameworkVersion --- 选择对应项目的.net版本(目前支持到4.0)
②、ProjectSummary --- 项目说明-编译后的chm--Title属性名称
③、HtmlHelpName --- 输出chm文件的名称
④、HelpTitle --- 文件标题说明
⑤、HelpFileFormat --- 选择HtmlHelp1
⑥、Language --- 默认选中“英语(美国)”
⑦、CopyrightText --- 你的版权说明
⑧、DocumentInheritedFrameworkMembers ---- false true<将屏蔽继承过来的自带的一些方法说明>
⑨、DocumentInheritedMembers ---- false true<将屏蔽继承过来的自带的一些方法说明>
⑩、OutputPath --- 输出chm的文件夹
其他属性可默认....
5、点击“Bulid the help file”按钮进行编译操作,
解说:项目生成输出xml文件操作---》点击项目属性,弹出对话---生成--勾选中 输出XML文档文件,下次编译即可输出xml文件