天天看点

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    很久以前就使用adb这个工具来生成项目的帮助文档。功能强大,在学习一些开源项目的过程中,官方没有提供chm帮助文档,所以为了快速的了解项目结构和注释。就生成文档来自己看,非常好用。这也是一个学习方法吧。例如本文在:

<a href="http://www.cnblogs.com/asxinyu/p/dotnet_opensource_project_comparenet.html">.net平台开源项目速览(2)compare .net objects对象比较组件</a>

<a href="http://www.cnblogs.com/asxinyu/p/dotnet_opensource_project_litedb.html">.net平台开源项目速览(3)小巧轻量级nosql文件数据库litedb</a>

  上述2篇文章中最后的资源中就手动制作了chm帮助文档。有时候我们还可以对源码进行翻译,再制作,效果还不错。今天介绍的adb工具,我使用的是基于x组件的一个改进版。改进的细节我也不太清楚,反正非常好用。下面来看看介绍和使用方法。

     程序的注释在程序的编写和维护中扮演着相当重要的角色,在visual c#中,可以为代码创建文档,方法是在xml标记所指的代码块前面,直接在源代码的特殊注释字段中包括xml 标记。编译器编译时将在源代码中搜索所有的 xml 标记,并创建一个xml文档文件。.net文档生成工具(下文简称为adb)通过反射程序集及其代码中的xml注释来创建msdn形式的api文档。

    注意:使用该软件需先安装microsoft html help workshop,主要作用有:   

(1)根据程序集及其对应的xml文档文件生成风格类似msdn的文档,并打包为chm文件;

(2)将多个程序集对应的文档合并到一个文档中;

(3)自动搜索程序集及其引用的程序集对应的xml文档(包括.net自带的程序集,如:system.xml);

(4)灵活控制在文档中显示哪些成员(如:只生成公共方法);

(5)界面友好,操作简便。

(6)用户可以根据自己的需要扩展xml标志;

(7)用户可以根据自己的需要编写自定义的文档生成器。

    adb官方提供的最新版是2.3,可以去上面的链接下载最新版,我这里分享的是@大石头使用x组件重新编译后的版本。

    使用过程分为3个步骤:

    adb代码生成主要是根据项目的注释来进行生成的。例如c#中注释的标记:

    当然还有更多的标记符号,例如example,code,see等等。如果想做很完善的帮助文档,那这些细节处理得越好,那文档的作用就越强大。

    项目编译之前,要确认是否生成xml文件,打开 项目属性-&gt;生成-&gt;输出 节点,如下图:

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    确认勾选xml文档文件选项。生成的时候就是根据这个xml的注释来进行的。

    打开adb软件,我在第3节提供2个版本的下载,如果需要自己编译其他版本,打开adb软件,如下图:

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    输入标题后,添加你要生成的文档的dll文件,可以添加多个,然后如果你生成了对应的xml文件,会自动加载进来。否则会报错。如下图:

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    还可以只添加你想要的类型以及方法。一般非公共类型可以不加进去。最后点”创建文档”就ok了,它会生成到你xml文件的目录。

注意2个小问题:你的chm的文件标题要规范一点,什么#号,:号等都不要加上去,否则会报错,有时候很头疼。。。经常会忘记这一个,有时候还不止咋搞,就错误。如下图所示,标题就有问题:

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    好了,不说了,说多了都是泪。下面看看我生成的一些文档:

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

    效果不错哦。。。赶紧试试。

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用1.ADB介绍2.ADB生成.NET文档过程3.资源与代码

大多数人安装html help workshop 会默认安在c盘,

我将 html help workshop 安装到d盘时,生成时会报"系统找不到指定的文件"。

在源码里,将createchm()方法中的

“_hhcprocess.startinfo.filename = _defaulthhcpath; ” ,_defaulthhcpath 改成 hhcpath 就可以正常生成了。