.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

Sandcastle的，由Microsoft创建的，是从创建MSDN风格的文档中使用的工具。NET程序集和关联的XML注释文件。目前的版本是2010年6月发布。这是命令行并没有GUI前端，项目管理功能，或像，你可以找到在NDoc的自动生成过程。 Sandcastle的帮助文件生成器，填补空白，提供失踪NDoc的样是最常用的的功能，并提供基于图形和命令行的工具，以建立一个自动化的方式帮助文件。

必备软件：HtmlHelpWorkshop.exe 网上到处都有；如果本机已经安装就无需理会；

下面介绍开始如何使用该软件：

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、点击“右边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文件

转载的:http://blog.csdn.net/w3031213101/article/details/6659739

转载于:https://www.cnblogs.com/spring_wang/p/5900990.html

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具相关推荐

用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
Swagger是一个描述RESTful的Web API的规范和框架.如果使用ASP.NET的话,可以用Swashbuckle来自动生成Swagger,具体参考如何使 WebAPI 自动生成漂亮又实用在 ...
Sandcastle方法生成c#.net帮助类帮助文档chm
Sandcastle方法生成c#.net帮助类帮助文档chm Sandcastle方法生成c#.net帮助类帮助文档即chm后缀的文档,其实是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第 ...
【项目】---文档快速搜索工具
目录一.项目背景二.项目需求分析三.项目涉及的知识点四.项目实现的基础理论五.项目框架六.增加系统工具模块 6.1.扫描本地的文件的功能七.增加数据管理模块 7.1.先了解数据库sqli ...
JAVA微信开源项目（jeewx）百度BAE 部署文档
JeeWx(捷微) 百度BAE 部署文档开始前的准备 1. WAR包下载地址: 链接: http://pan.baidu.com/s/1bnlcsk3 密码: 592i 下载war包和sql脚本文 ...
Unity学习笔记：个人学习项目《疯狂天才埃德加》纠错文档
Unity学习笔记:个人学习项目<疯狂天才埃德加>纠错文档本文档是完成学校Unity课程作业时建立的纠错文档.用于记录自己开发过程中遇到的各种问题,以便下次遇到相同的问题时及时找到解决方 ...
项目 - 文档快速搜索工具
一.项目简介: Linux操作系统中提供了find指令查找指定文件,为了实现在Windows操作系统中实现文件的快搜搜索,利用所学知识实现文件搜索工具,与软件everything工具具有一定的相同功能 ...
商城项目（六）整合Mongodb实现文档操作
商城项目(六)整合Mongodb实现文档操作整合Mongodb的过程,以实现商品浏览记录在Mongodb中的添加.删除.查询为例. 环境搭建 Mongodb Mongodb是为快速开发互联网Web应 ...
Vue+ElementUi 项目中将页面内容转为 Word文档下载
Vue+ElementUi 项目中将页面内容转为 Word文档下载需要提前做好的现成模板(魔板个页面基本上相同的内容)-模板内有变量,替换成页面对应的数据 HTML页面: 转换的word 以下是正 ...
制药企业SAP项目中CSV认证需要准备的文档
制药企业SAP项目中CSV认证需要准备的文档 CSV,英文全称是Computerized System Validation,中文是计算机化系统验证.很多行业的企业信息化建设过程中,都要确保自己实施的 ...
HbuilderX 左侧项目栏文件位置和打开的文档同步（对应显示） - 设置篇
HbuilderX能像Hbuilder一样,左侧的项目栏文件位置和打开的文档同步,对应显示设置 · 截图演示:(按图设置即可完成.) 以上就是关于" HbuilderX左侧项目栏文件位置和 ...

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具相关推荐

最新文章

热门文章