• Sandcastle Help File Builder 说明文档


    1. 概述

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

    2. 安装说明

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

    3. 新建工程

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

    clip_image004

    4. 添加源文件

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

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

    clip_image006

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

    5.属性说明

    Build属性(下图所示):

    clip_image008

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

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

    Help File属性(如下图):

    clip_image010

    该属性注意的设置有:

    Help title:帮助文档的标题

    Help file name:帮助文档的名称

    Help file language:帮助文档的语言

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

    Visibility属性(如下图):

    clip_image012

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

    Missing Tags属性(如下图):

    clip_image014

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

    Path属性(如下图):

    clip_image016

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

    5.生成帮助文档

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

    clip_image018

    附录:

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

    http://shfb.codeplex.com/documentation

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

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

  • 相关阅读:
    open()函数与读写文件
    vim编辑器常用操作
    strip()函数---去除字符串首尾字符
    Python中字符串转义的用法
    shell中内置字段的分隔符IFS
    shell中整数变量自增用法
    shell中EOF的用法
    shell变量字符串截取
    shell中的“数组”
    年终总结:想的多了就该敷衍性得记录一下
  • 原文地址:https://www.cnblogs.com/sauronKing/p/4791640.html
Copyright © 2020-2023  润新知