当前位置:编程学习 > C#/ASP.NET >>

.NET文档生成工具

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

.NET文档生成工具2.2下载

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">

ADB2.2使用方法

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

2.主界面:


3.批量选择界面:


4.生成过程:


5.生成的文档


6.在注释中使用HTML标志

示例注释:

<summary>
<ul>
<li>123456</li>
<li><see cref="Class3<T>"/><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>

示例注释对应的文档:


7.使用SuperCHM修改文档
(修改前请阅读与目标CHM文件同目录下的"修改文档.html"文件)


由于水平有限,错误在所难免,如果您对该软件有任何意见或建议,请发送邮件到mrlucc@126.com,欢迎大家提出意见,以完善这个软件。
--------------------编程问答-------------------- 顶!接分!
--------------------编程问答-------------------- 支持一下! --------------------编程问答-------------------- 好东东一定要顶,先顶再看!!! --------------------编程问答-------------------- 好东西啊,顶上 --------------------编程问答-------------------- 自己頂一下 --------------------编程问答-------------------- 接分~~~ --------------------编程问答-------------------- up --------------------编程问答-------------------- 好东西先收藏了,以后可能用的上! --------------------编程问答-------------------- 好东西,赞一个 --------------------编程问答-------------------- mark

--------------------编程问答-------------------- 顶啊 --------------------编程问答-------------------- 太感谢楼主了
--------------------编程问答-------------------- 再顶 --------------------编程问答-------------------- 再顶
补充:.NET技术 ,  C#
CopyRight © 2012 站长网 编程知识问答 www.zzzyk.com All Rights Reserved
部份技术文章来自网络,