Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcastle Sandcastle生成的输出结果具有以下特点: Ø         类似于MSDN布局的界面.  Ø         自动生成索引项.内容项目表.主题块和页面布局,提高一致性和熟悉程度. Ø         自动生成语法宣称部分.  Ø         自动生成继承表.  Ø         代码彩色化.  Ø         提供多…
作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范围有限,且官网没有明确说明它与VS版本的区别.导致经常出现"明明装了SHFB,但VS打开不了它的项目"问题. 这时只有逐个版本安装尝试了.而GitHub下载速度慢,导致要花很久时间才能找到合适的版本.于是我做了一次完整的实验,有了一些心得. 二.心得 2.1 尝试安装2个版本 最初曾经试过…
Sandcastle Help File Builder   http://shfb.codeplex.com/…
使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档 下载地址:http://sandcastle.codeplex.com/ 下载地址2:http://shfb.codeplex.com/downloads/get/1408995 根据这两种图就下一步下一步的安装.安装之后会在你的开始菜单里看到"Sandcastle Help File Builder"这个文件夹如下: 第二:我们来简单的建一个项目,写一个方法. public class…
Sandcastle Help File Builder相信很多的园友用过,小弟我最近因为工作原因需要生成公司的一套SDK的帮助文档,因此找了一些资料,发现网上的资料很多,但是都不怎么完全,有些只是随便写了一些类,生成一个帮助文档.没有整体性,因此在这里将我的一些步骤贴出来,供大家讨论.Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目,Sandcastle 本身是一个console…
1.下载安装 Sandcastle 程序. http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029 2.在程序中使用批注将代码注释说明清楚. 标记 说明 <event> 对某个成员可能引发的事件的说明. <example> “示例”,帮助类库使用者理解…
使用 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:\Pr…
由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…
由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…
由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…