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
转载于:https://www.cnblogs.com/sauronKing/p/4791640.html
Sandcastle Help File Builder 说明文档相关推荐
- Sandcastle Help File Builder(.NET帮助文档工具)的版本选择心得——支持VS2010至VS2015,高版本项目文件问题...
作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范 ...
- 『原创』教你如何使用Sandcastle Help File Builder建立MSDN风格的代码文档
今天在公司特别研究了Sandcastle.NDoc以及Sandcastle Help File Builder(以下简称SHFB)的使用,发现还是SFHB好用,特在此写下一篇供大家参考(毕竟那个界面是 ...
- 文档生成工具Sandcastle Help File Builder
Sandcastle Help File Builder http://shfb.codeplex.com/ 转载于:https://www.cnblogs.com/liuxinls/p/330172 ...
- Sandcastle Help File Builder
最近我和其它部门配合,给他们提供一个外部服务,既然是提供给别人用的,当然需要告诉别人怎么来用你的服务,这也就是我们常说的技术文档.各组之间传递技术文档的方式有很多种.这里我知道的大概有以下几种: 第一 ...
- Sandcastle Help File Builder[Missing summary documentation for ]
实现SHFB的软件环境: 首先:需要安装Sandcastle,搜索下载最新版本. 其实:就是chm文件的制作软件HTML Help Workshop.路径:http://download. ...
- Sandcastle Help File Builder BE0032报错
这是软件找不到与 .net 版本相对应的reflection data XML files所致 原因一: 环境变量SHFBROOT位置指向错误,未指向软件所在目录.官方答案在这里 解决办法: 查看你的 ...
- Sandcastle Help File Builder BE0037报错
原因一:你没安装HTML Help Workshop 解决方法: 去这里下载安装 安装了之后还有报错 原因: SHFB并不是在找HTML Help Workshop这个程序,而是搜索HTML Help ...
- 编程以外积累: 如何给项目生成类似VS2008的说明文档
1:[下载] 目前微软提供的官方开源工具 Sandcastle 结果跑到项目中一看,抬头就来了这么一段: The Sandcastle CodePlex project is no longer u ...
- Atomikos 中文说明文档【转】
Atomikos 翻译文档(英文文档来源:下载安装包中START_HERE.html) ----译者:周枫 请尊重劳动成果,转载请标明 ...
最新文章
- 都说百度前端牛,来看看百度前端工程化之H5性能优化
- 使用WinSCP在WIndows与树莓派之间传递文件
- opencv中的矩阵拼接
- vue之vue-router跳转
- #ifndef #define #endif 和#pragma once的区别
- 【Docker】Docker 启用 Kubernetes 报错 insecure-registries Must be host[ port] or CIDR
- 【Python3爬虫】微博用户爬虫
- python 计算机程序设计-计算机二级教程python第一章 程序设计语言
- html中的rem做响应式,使用rem制作响应式网站
- 第十届泰迪杯数据挖掘大赛B题电力系统负荷预测
- 橡胶支座抗压弹性模量计算公式_板式橡胶支座抗压弹性模量检测方法的试验研究...
- “让我帮你百度一下”源码
- What's the AOP?
- C++制作加密聊天程序:这样设置一下,再也不用担心女朋友翻你手机了!
- 使用二手书App的心得
- Unity摄像机拍照并显示在小窗口里(RenderTexture和RawImage将摄像机图像渲染到GUI屏幕上小图显示)
- element-plus的el-date-picker中value-format属性失效以及只选择到时分值
- 【OI做题记录】【BZOJ】【Usaco2008 Mar】土地购买
- utf8版 中文转换成拼音
- 好用的平板触控笔,apple pencil的平替笔推荐