zoukankan      html  css  js  c++  java
  • 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm

       Sandcastle的,由Microsoft创建的,是从创建MSDN风格的文档中使用的工具。NET程序集和关联的XML注释文件。目前的版本是2010年6月发布。这是命令行并没有GUI前端,项目管理功能,或像,你可以找到在NDoc的自动生成过程。 Sandcastle的帮助文件生成器,填补空白,提供失踪NDoc的样是最常用的的功能,并提供基于图形和命令行的工具,以建立一个自动化的方式帮助文件。

          必备软件:HtmlHelpWorkshop.exe 网上到处都有;如果本机已经安装就无需理会;

          下面介绍开始如何使用该软件:

          1、下载该软件,网址:http://shfb.codeplex.com/

                 解压找到文件夹InstallResources;可找到两个安装包Sandcastle_Jun_2010.msi;SandcastleHelpFileBuilder_1930.msi

          2、开始安装,需要装两个软件

        安装  SandcastleInstaller.exe,把里面所有的组件都安装一遍。

          3、安装完毕后,在程序中可以找到“Sandcastle Help File Builder GUI”执行文件,运行:(先新建了一个工程)

           使用步骤:

            1、点击“File”--> New Project -->弹出对话框,输入工程名称,比如:NewDoc,点击保存

            2、见NewDoc工程如下图:

             

            3、点击“右边NewDoc”下面“Documentation Source”,点击右键Add,选择我们开发项目已经编译好的dll和xml文件(注意:项目编译必须输出 xml文件,方法见下面解说)

            4、配置相关属性;

                       ①、FrameworkVersion --- 选择对应项目的.net版本(目前支持到4.0)

                       ②、ProjectSummary     ---  项目说明-编译后的chm--Title属性名称

                       ③、HtmlHelpName       ---   输出chm文件的名称

                       ④、HelpTitle                  ---   文件标题说明

                       ⑤、HelpFileFormat      ---   选择HtmlHelp1

                       ⑥、Language               ---   默认选中“英语(美国)”

                       ⑦、CopyrightText        ---   你的版权说明

                       ⑧、DocumentInheritedFrameworkMembers   ---- false    true<将屏蔽继承过来的自带的一些方法说明>

                       ⑨、DocumentInheritedMembers                       ---- false    true<将屏蔽继承过来的自带的一些方法说明>

                       ⑩、OutputPath            ---  输出chm的文件夹

                       其他属性可默认....

              5、点击“Bulid the help file”按钮进行编译操作,

                     

     解说:项目生成输出xml文件操作---》点击项目属性,弹出对话---生成--勾选中 输出XML文档文件,下次编译即可输出xml文件  

         

  • 相关阅读:
    Pretty girl,你一定要去旅行
    难受就哭,开心就笑
    你对你的大学生活满意吧
    [leetCode]575. 分糖果
    [leetCode]383.赎金信
    242. 有效的字母异位词
    [leetCode]538. 把二叉搜索树转换为累加树
    [leetCode]面试题 02.07. 链表相交
    [leetCode]206. 反转链表
    [leetCode]707. 设计链表
  • 原文地址:https://www.cnblogs.com/jjg0519/p/8478754.html
Copyright © 2011-2022 走看看