Sandcastle Help File Builder 说明文档

1. 概述

该应用可以根据我们编译的程序集或者VS工程自动生成相应的帮助文档。

2. 安装说明

https://github.com/EWSoftware/SHFB/releases下载最新的安装包,解压到文件夹,运行SandcastleInstaller.exe进行安装。

3. 新建工程

安装完成后,打开应用程序,File->New Project,输入文件名,点击保存,出现如下界面:

4. 添加源文件

右键点击Project Explorer中的Documentation Sources结点,选择Add Documentation Sources…

在出现的对话框中选择要产生说明文档的程序集或者VS工程,必须选择VS生成的xml文档(如下图所示:)

下一步是添加引用程序集。引用程序集是与Documentation Sources相关联的程序集,Documentation Sources中的很多继承类或者成员信息都需要引用程序集提供。但是引用程序集不会生成说明文档(可以不添加)。

5.属性说明

Build属性(下图所示):

在Build属性页面的左侧,是生成帮助文档的格式,选择第一种即可。

在Build属性页面的右侧,包含Framework的版本,log文件的名称等其他设置

Help File属性(如下图):

该属性注意的设置有:

Help title:帮助文档的标题

Help file name:帮助文档的名称

Help file language:帮助文档的语言

Syntax filters:语法过滤器,根据哪种语言的语法来生成帮助文档

Visibility属性(如下图):

相当于生成的帮助文档的权限控制,一般情况下,我们会屏蔽掉私有的字段属性和方法。

Missing Tags属性(如下图):

Missing Tags属性主要设置哪些XML标记可以生成到帮助文档中,比如:如果命名空间没有注释,则Namespace documentation选项不应该勾选

Path属性(如下图):

Help content output path选项主要设置帮助文档生成的路径

5.生成帮助文档

点击菜单栏的Documentation选项的Build Project或者直接点击工具栏的Build Project生成帮助文档,如果出现错误,可以在output选项卡中切换显示界面来查看error信息

附录:

具体详细关于Sandcastle Help File Builder的文档,参考

http://shfb.codeplex.com/documentation

如果想参考Sandcastle Help File Builder 的源代码,访问

http://shfb.codeplex.com/SourceControl/latest#ReadMe.txt

时间: 2024-11-05 21:58:22

Sandcastle Help File Builder 说明文档的相关文章

使用 Sandcastle Help File Builder 制作文档

1.下载安装 Sandcastle 程序. http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029 2.在程序中使用批注将代码注释说明清楚. 标记 说明 <event> 对某个成员可能引发的事件的说明. <example> “示例”,帮助类库使用者理解

Sandcastle+SandcastleHelpFileBuilder生成说明文档

1  安装说明 (1). 安装HTML Help Workshop. (2). 安装Sandcastle. (3). 安装SandcastleHelpFileBuilder. (4). 安装SandcastleHelpFileBuilder的Visual Studio插件(可选, SHFBVisualStudioPackage.vsix). (5). 添加环境变量:”SHFBROOT”,值为SandcastleHelpFileBuilder的安装路径,如” C:\Program Files (x

使用SandCastle创建.Net帮助文档

使用SandCastle创建.Net帮助文档 引用自:http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builde

文件上传到百度云盘说明文档

图1 图2 图3 图4 1. 上传百度云盘功能,由于百度开发者中还没有开放对.net 操作的SDK,所以我们现在只能使用原生的REST API   我们的做法就是如何用C# 语言调用 调用curl 命令. 2. curl是利用URL语法在命令行方式下工作的开源文件传输工具.它被广泛应用在Unix.多种Linux发行版中,并且有DOS和Win32.Win64下的移植版本. 要操作curl 我们需要引入LibCurlNet.dll   3.百度上传我们需要有百度账号,而且需要申请开发者功能进入主页后

Java Servlet API中文说明文档

Java Servlet API中文说明文档译者前言:       近来在整理有关Servlet资料时发现,在网上竟然找不到一份中文的Java Servlet API的说明文档,而在有一本有关JSP的书后面附的Java Servlet API说明竟然不全,而这份文档的2.1a版在1998年的11月份就已定稿.所以我决定翻译一份中文的文档(其中一些与技术关系不大的部分已被略去),有兴趣的读者可以从http: //java.sun.com/products/servlet/2.1/servletsp

TCPDF说明文档

TCPDF说明文档 一.首先调用TCPDF文件 require_once('tcpdf.php'); 二.实例化TCPDF类 页面方向(P =肖像,L =景观).测量(mm).页面格式 $pdf = new TCPDF('P', 'mm', 'A4', true, 'UTF-8', false); 三.设置文档信息 设置文档信息----文件创作者 $pdf->SetCreator('Helloweba'); $pdf->SetAuthor('yueguangguang'); $pdf->

开源项目Universal Image Loader for Android 说明文档 (1) 简介

 When developing applications for Android, one often facesthe problem of displaying some graphical content from the Internet. So, youshould provide image loading from the Web in an Android app, their processingand displaying with limited memory aga

Atomikos 中文说明文档【转】

Atomikos 翻译文档(英文文档来源:下载安装包中START_HERE.html)                                  ----译者:周枫 请尊重劳动成果,转载请标明,英语水平有限,如有不准确地方请在评论中指出,谢谢 官网地址:http://www.atomikos.com/Main/WebHome 使用版本:AtomikosTransactionsEssentials-3.7.2 感谢您使用Atomikos,下面的说明文档可以让您正确使用,如果您有任何问题或者

Linux安装Oracle11g说明文档

Linux安装Oracle11G说明文档 一.          安装软件环境准备: n  Centos-6.5-X64.iso n  SecureCRT.exe n  FileZilla.exe n  linux.x64_11gR2_database_1of2.zip n  linux.x64_11gR2_database_2of2.zip     二.          安装Centos6.5系统 1:配置网络环境 根据需求设定为固定IP地址 [[email protected] ~]# v