『原创』教你如何使用Sandcastle Help File Builder建立MSDN风格的代码文档

今天在公司特别研究了Sandcastle、NDoc以及Sandcastle Help File Builder（以下简称SHFB）的使用，发现还是SFHB好用，特在此写下一篇供大家参考（毕竟那个界面是英文的，呵呵），过两天后将贴出大部分属性的说明（中文）。

首先，我们去http://www.codeplex.com/SHFB这里下载这个软件，安装，都按照默认就行。

其次，为了测试，我们使用VS2008在c# winform平台下建立一个类库项目，配置如下图：

然后，往默认的Class1.cs类中添加如下代码：

ReturnHello
/// <summary>
        /// 根据参数返回一个字符串，参数为1则返回Hello,为0则返回Hi
        /// </summary>
        /// <param name="i">参数</param>
        /// <returns>字符串</returns>
        /// <example>
        ///  string str=ReturnHello(1);
        /// </example>
        public string ReturnHello(int i)
        {
            switch (i)
            {
                case 1:
                    return "Hello";
                    //break;
                case 0:
                    return "Hi";
                    //break;
                default:
                    return "Please Input a int";
                    //break;
            }

}

然后，设置项目属性如下图：

记住：看到“输出”一栏，要在xml文档文件前打勾，路径使用默认即可。再回来生成一下项目。OK!

退出VS，打开SHFB,看到主界面，我们新建一个Project，名字随便，然后大家可以设置如下主要信息：

FrameworkVersion：框架版本，一般选择2.0的，当然根据不同的项目选择不同版本。

HelpFileFormat：这里我们不做更改

NamespaceSummaries和ProjectSummary的内容将会出现在生成的文档头部在这里我们留空即可

CopyRightText:版权信息，例如“微软”等

HelpTitle：文档标题，比如“XXXWeb控件类库”等

HtmlHelpName：生成的文件名称，可以定义为WebCommon或者你喜欢的名字

Language:语言，最好使用简体中文

PresentationStlye:显示样式，为了习惯，我们选择vs2005，也是最流行的显示样式

OutputPath:输出路径，这个想必大家都知道了

当然，还有一些比较个性化的设置如FootText这些的，都可以你自己去研究一下，然后呢，就是最重要的一步，我们要添加需要生成文档的Dll文件吧，设置好以后，我们看到右上角有个Documentation Sources，右键单击它，选择 Add Documentation Sources.，然后把上一步生成的那个HelloWorldLib.dll和配套的那个HelloWorldLib.xml文件一起添加进来。

然后，点击那个按钮，程序就开始编译了，经过一段时间，在右下角会有个进度条，生成成功后，程序会提示你：Build completed successfully at XXXXXXX某年某月的某一天

到此，我们的任务就可以算是完成了，然后转到OutPutpath的那个文件夹下，就可以看到一个.chm文档，我的如下图，呵呵：

OK，大功告成！

这里提供了整个例子的下载（包括代码和生成的文档，呵呵）：

运行环境：VS2008+.Net 3.5+C#

点此下载

转载于:https://www.cnblogs.com/longqi293/archive/2009/06/23/1509532.html

『原创』教你如何使用Sandcastle Help File Builder建立MSDN风格的代码文档相关推荐

微软云盘配合服务器,『原创』开源5T微软云盘搭建教程onedrive index
前言为什么搭建一个微软共享云盘?百度云.蓝奏云不好吗?百度云有会员限制功能,各种限制更是不少,蓝奏云速度超快,但是貌似不支持大文件.微软毕竟是大厂,可用的5T教育邮箱现在也很好搞到,之所以采用是因为 ...
『精』EditorConfig 小老鼠跨编辑器 | IDE 保持一致的编码风格
『精』EditorConfig 小老鼠跨编辑器 | IDE 保持一致的编码风格文章目录『精』EditorConfig 小老鼠跨编辑器 | IDE 保持一致的编码风格一.什么是EditorCo ...
文档生成工具Sandcastle Help File Builder
Sandcastle Help File Builder http://shfb.codeplex.com/ 转载于:https://www.cnblogs.com/liuxinls/p/330172 ...
Sandcastle Help File Builder（.NET帮助文档工具）的版本选择心得——支持VS2010至VS2015，高版本项目文件问题...
作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范 ...
Sandcastle Help File Builder
最近我和其它部门配合,给他们提供一个外部服务,既然是提供给别人用的,当然需要告诉别人怎么来用你的服务,这也就是我们常说的技术文档.各组之间传递技术文档的方式有很多种.这里我知道的大概有以下几种: 第一 ...
Sandcastle Help File Builder[Missing summary documentation for ]
实现SHFB的软件环境: 首先:需要安装Sandcastle,搜索下载最新版本. 其实:就是chm文件的制作软件HTML Help Workshop.路径:http://download. ...
Sandcastle Help File Builder 说明文档
Sandcastle Help File Builder 说明文档 1. 概述该应用可以根据我们编译的程序集或者VS工程自动生成相应的帮助文档. 2. 安装说明从https://github.co ...
『原创』+『参考』基于PPC的图像对比程序——使用直方图度量
前言的前言: 最近小弟闲来无聊,就想到了在PPC上面来做个图像对比的小东东,查找各方资料,终于在今天初步完成了这个程序,现在整理之后和各位共勉.程序中还存在很多不足之处,大家尽管提出自己的意见和建议, ...
『原创』用C++开发WM应用系列（6）——深化ListBox控件
用C++开发WM应用系列文章索引引言: 在上一篇博文中,我们简单的学习了ListBox控件的项添加.项的全部清除.接上一篇的尾巴,我们将在这篇博文中,介绍一些ListBox的小技巧吧,比如,获取选中 ...

『原创』教你如何使用Sandcastle Help File Builder建立MSDN风格的代码文档

『原创』教你如何使用Sandcastle Help File Builder建立MSDN风格的代码文档相关推荐

最新文章

热门文章