程序的注释在程序的编写和维护中扮演着相当重要的角色,在生成工程的同时,说明文档也随之而生了。.net 文档生成工具用于将xml 文档注释生成格式类似MSDN的HTML帮助文档,并编译为CHM文档。 [color=#FF0000](下文中将该工具称为ADB,该软件仅测试过.net2.0的程序集)[/color]

[url=http://www.cnblogs.com/lucc/archive/2008/09/01/1281085.html].NET文档生成工具2.2下载[/url]

ADB的功能有:
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">

[size=3][b]ADB2.2使用方法[/b][/size]

[b]1.步骤:[/b]
(1) 点击添加,选择要生成文档的程序集;
(2) 选择将在文档中显示该成员;
(3) 输入标题,点击创建文档。

[b]2.主界面:[/b]
[img]http://images.cnblogs.com/cnblogs_com/lucc/3.PNG[/img]

[b]3.批量选择界面:[/b]
[img]http://images.cnblogs.com/cnblogs_com/lucc/1.PNG[/img]

[b]4.生成过程:[/b]
[img]http://images.cnblogs.com/cnblogs_com/lucc/2.PNG[/img]

[b]5.生成的文档[/b]
[img]http://images.cnblogs.com/cnblogs_com/lucc/4.PNG[/img]

[b]6.在注释中使用HTML标志[/b]

示例注释:

<summary>
<ul>
<li>123456</li>
<li><see cref="Class3&lt;T&gt;"/><a href="http://www.baidu.com">1234</a></li>
</ul>
</summary>
<remarks>
<img src="Image\1.gif"/>
</remarks>
<example>
Example1
<code src="1.cs"/>
Example2
<code src="1.cs"/>
</example>

示例注释对应的文档:
[img]http://images.cnblogs.com/cnblogs_com/lucc/2008110701.PNG[/img]

[b]7.使用SuperCHM修改文档[/b]
[color=#FF0000](修改前请阅读与目标CHM文件同目录下的"修改文档.html"文件)[/color]
[img]http://images.cnblogs.com/cnblogs_com/lucc/2008110702.PNG[/img]

由于水平有限,错误在所难免,如果您对该软件有任何意见或建议,请发送邮件到mrlucc@126.com,欢迎大家提出意见,以完善这个软件。