程序的注释在程序的编写和维护中扮演着相当重要的角色,在生成工程的同时,说明文档也随之而生了。.net 文档生成工具用于将xml 文档注释生成格式类似MSDN的HTML帮助文档,并编译为CHM文档。(下文中将该工具称为ADB,该软件仅测试过.net2.0的程序集)
ADB具有以下特点:
1.可以合并多个程序集;
2.自动搜索程序集及其引用的程序集对应的XML文档(包括.Net自带的程序集,如:system.xml);
3.灵活控制生成哪些成员,支持批量选择(如:选择所有公共的方法);
4.使用简单。
下载ADB
下载源代码
ADB支持的标志:
<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.批量选择界面:

4.生成过程:

5.生成的文档:

下载ADB
下载源代码