.Net工具 - .NET文档生成工具2.2

ADB2.2下载   ADB2.2源代码下载

一、概述

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

二、ADB2.2的功能特点

1、支持合并多个程序集;

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

3、灵活控制在文档中显示哪些成员,支持批量选择(如:选择所有公共的方法);

4、支持自定义文档生成器,用户可以通过继承ADB提供的基类编写自己的文档生成器。

三、ADB2.2支持的注释标记

标志名

说明

语法

参数

<summary>

对象的摘要,用于描述类型或类型成员

<summary>description</summary>

description:对象的摘要。

<remarks>

类型说明的补充信息

<remarks>description</remarks>

description:成员的说明。

<param>

用于方法声明的注释中,以描述方法的一个参数

<param name='name'>description</param>

name:方法参数名。将此名称用双引号括起来 (" ")。

description:参数说明。

<returns>

用于方法声明的注释,以描述返回值

<returns>description</returns>

description:返回值的说明。

<value>

描述属性所代表的值

<value>property-description</value>

property-description:属性的说明

<example>

指定使用方法或其他库成员的示例,通常涉及使用 <code> 标记

<example>description</example>

description: 代码示例的说明。

<code>

提供了一种将多行指示为代码的方法。

<code>content</code>

content:希望将其标记为代码的文本。

<exception>

指定哪些异常可被引发,该标记应用于方法定义。

<exception cref="member">description</exception>

cref:对可从当前编译环境中获取的异常的引用。

description:异常的说明。

<see>

从文本内指定链接

<see cref="member"/>

cref:对可以通过当前编译环境进行调用的成员或字段的引用。

<para>

<para> 标记用于诸如<summary><remarks> <returns> 等标记内,使您得以将结构添加到文本中。

<para>content</para>

content:段落文本。

<code>*

提供了一种插入代码的方法。

<code src="src" language="lan" encoding="c"/>

src:代码文件的位置

language:代码的计算机语言

encoding:文件的编码

<img>*

用以在文档中插入图片

<img src="src"/>

src:图片的位置,相对于注释所在的XML文件

<file>*

用以在文档中插入文件,在页面中表现为下载链接

<file src="src"/>

src:文件的位置,相对于注释所在的XML文件

<localize>*

提供一种注释本地化的方法,名称与当前线程语言不同的子节点将被忽略

<localize>

 <zh-CHS>中文</zh-CHS>

 <en>English</en>

 ...

</localize>

 

1*表示ADB自带的文档生成器扩展的标记;

2、其它不支持的标志将视为HTML标记。

四、生成文档

1.步骤

(1) 点击添加,选择要生成文档的程序集;

(2) 选择将在文档中显示该成员;

(3) 输入标题,点击创建文档。

2.主界面

3.批量选择界面

4.生成的文档——命名空间页面

5.生成的文档——类型页面

6.生成的文档——成员页面

 

五、修改生成的文档

使用SuperCHM或其它CHM制作工具,打开Pages"temp.hhp(相对于生成的CHM文件)文件进行修改,修改前请阅读与目标CHM文件同目录下的"修改文档.html"文件

NET资源文件生成器(ResourceWorkshop)是专业的资源文件开发工具,集成了VS.NET中的所有资源文件开发工具的功能,是.NET程序员的必备工具。它有中英文两种语言版本,支持多文档窗口,具有独特的文件关联功能,使您编缉资源文件时更加得心应手。 主要功能: 1、支持.NET框架下的三种资源文件格式(.txt文件、.resX文件和.Resources文件)。 2、支持字符串、颜色、图片、光标等各种资源。 3、提供了添加、删除、重命名、剪切、复制、粘贴等常用编缉功能。 4、支持多文档窗口,可同时编缉多个文件。 5、可将不同资源文件格式之间的相互转换。 6、可将多个不同格式的资源文件合并为一个资源文件。 7、提供了资源文件关联功能,便于对照比较多个资源文件。 设置资源文件关联,是本程序的一个特色功能。将多个资源文件关联在一起,并将其中一个作为主动文件,当主动文件的当前资源项改变时,其它文件中的当前资源项也随之变化,指向与之同名的资源。类似Foxbase中数据库之间的关联功能,被动数据库中的记录指针随着主动数据库的记录指针变化。 当被动资源文件中找不到与主动资源文件中同名的资源时,根据不同的设置,可定位到第一项资源或询问是否复制资源或自动复制资源。 请到我们的主页http://www.guohuasoft.com下载最新版本。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

lzhdim

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值