1. 概述

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

2. 安装说明

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

3. 新建工程

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

Sandcastle Help File Builder 说明文档

4. 添加源文件

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

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

Sandcastle Help File Builder 说明文档

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

5.属性说明

Build属性(下图所示):

Sandcastle Help File Builder 说明文档

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

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

Help File属性(如下图):

Sandcastle Help File Builder 说明文档

该属性注意的设置有:

Help title:帮助文档的标题

Help file name:帮助文档的名称

Help file language:帮助文档的语言

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

Visibility属性(如下图):

Sandcastle Help File Builder 说明文档

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

Missing Tags属性(如下图):

Sandcastle Help File Builder 说明文档

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

Path属性(如下图):

Sandcastle Help File Builder 说明文档

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

5.生成帮助文档

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

Sandcastle Help File Builder 说明文档

附录:

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

http://shfb.codeplex.com/documentation

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

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

posted on 2015-09-08 14:42 SauronKing 阅读(...) 评论(...) 编辑 收藏

相关文章:

  • 2021-09-18
  • 2021-08-22
  • 2021-07-24
  • 2021-04-26
  • 2022-02-17
  • 2021-11-26
  • 2022-01-31
猜你喜欢
  • 2022-12-23
  • 2021-06-04
  • 2021-09-06
  • 2021-06-07
  • 2022-12-23
  • 2021-08-19
相关资源
相似解决方案