# DotNET文档生成工具ADB for 4.0 **Repository Path**: wwzj2020/ADB ## Basic Information - **Project Name**: DotNET文档生成工具ADB for 4.0 - **Description**: 原作者：卢春城 注意：使用该软件需先安装Microsoft HTML Help Workshop 程序的注释在程序的编写和维护中扮演着相当重要的角色，在Visual C#中，可以为代码创建文档，方法是在XML标记所指的代码块前面，直接在源代码的特殊注释字段中包括XML 标记。编译器编译时将在源代码中搜索所有的 XML 标记，并创建一个XML文档文件。.NET文档生成工具(下文简称为ADB)通过反射程序集及其代码中的XML注释来创建MSDN形式的API文档。 1.ADB2.3的功能特性： (1)根据程序集及其对应的XML文档文件生成风格类似MSDN的文档，并打包为CHM文件； (2)将多个程序集对应的文档合并到一个文档中； (3)自动搜索程序集及其引用的程序集对应的XML文档（包括.Net自带的程序集,如：System.xml）； (4)灵活控制在文档中显示哪些成员（如：只生成公共方法）； (5)界面友好，操作简便。 (6)用户可以根据自己的需要扩展XML标志； (7)用户可以根据自己的需要编写自定义的文档生成器。 - **Primary Language**: C# - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 0 - **Created**: 2021-01-13 - **Last Updated**: 2024-11-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # DotNET文档生成工具ADB for 4.0 #### 介绍 原作者：卢春城 注意：使用该软件需先安装Microsoft HTML Help Workshop 程序的注释在程序的编写和维护中扮演着相当重要的角色，在Visual C#中，可以为代码创建文档，方法是在XML标记所指的代码块前面，直接在源代码的特殊注释字段中包括XML 标记。编译器编译时将在源代码中搜索所有的 XML 标记，并创建一个XML文档文件。.NET文档生成工具(下文简称为ADB)通过反射程序集及其代码中的XML注释来创建MSDN形式的API文档。 1.ADB2.3的功能特性： (1)根据程序集及其对应的XML文档文件生成风格类似MSDN的文档，并打包为CHM文件； (2)将多个程序集对应的文档合并到一个文档中； (3)自动搜索程序集及其引用的程序集对应的XML文档（包括.Net自带的程序集,如：System.xml）； (4)灵活控制在文档中显示哪些成员（如：只生成公共方法）； (5)界面友好，操作简便。 (6)用户可以根据自己的需要扩展XML标志； (7)用户可以根据自己的需要编写自定义的文档生成器。 #### 软件架构 软件架构说明 #### 安装教程 1. xxxx 2. xxxx 3. xxxx #### 使用说明 1. xxxx 2. xxxx 3. xxxx #### 参与贡献 1. Fork 本仓库 2. 新建 Feat_xxx 分支 3. 提交代码 4. 新建 Pull Request #### 特技 1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md 2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) 3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) 6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)