使用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文件  

     

    程序的注释在程序的编写和维护中扮演着相当重要的角色,在生成工程的同时,说明文档也随之而生了。.net 文档生成工具用于将xml 文档注释生成格式类似MSDN的HTML帮助文档,并编译为CHM文档。(下文中将该工具称为ADB,该软件仅测试过.net2.0的程序集) .NET文档生成工具下载  .net文档生成工具2.1下载 .net文档生成工具2.0下载  .net文档生成工具1.0下载  源代码下载 .net 文档生成工具2.1源代码下载 相关连接 编写文档生成器(ADB2.0) 编写文档生成器(ADB2.1) 各版本说明 版本2.1.0.0 1.增加检测更新功能; 2.修改加载文档生成器的方式; 2.增加检测文档生成器版本的功能。   版本2.0.0.0 1.修正1.0中有时加载程序集错误的Bug; 2.增加自定义文档生成器的功能。   版本1.0.0.0: 1、合并多个程序集; 2、自动搜索程序集及其引用的程序集对应的XML文档(包括.Net自带的程序集,如:system.xml); 3、控制在文档中显示哪些成员,支持批量选择(如:选择所有公共的方法);  4、提供一个CHM文档生成器,用于生成类似MSDN的HTML文档,并编译成CHM文档,该文档生成器支持以下注释标注:     <code> <param> <example> <summary> <exception> <remarks> <return> <value>     <code>扩展了3个属性:src-用于指定存放代码的文件,encoding-指定文件的编码,language-代码使用的语言,例如:     <code language="C#" src="code.cs" encoding="GBK">   使用方法 1.步骤: (1) 点击添加,选择要生成文档的程序集; (2) 选择将在文档中显示该成员; (3) 输入标题,点击创建文档。   2.主界面:   3.批量选择界面:
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值