简单实用的数据库文档生成器

哈喽，大家好！我是指北君。

大家有没有过这样的经历：在DeadLine即将来临之际，文档尚未完成，面对纷繁复杂的数据库中各种表、视图、关联、存储过程等，你都不知道如何清晰准确的描述他们，不得不一个个打开表、视图、存储过程等查看，甚至可能因为疏漏而没有在文档上描述，导致验收不通过？现在我向各位伙伴推荐一款实用小工具：DBCHM！

一、工具介绍

DBCHM，是一个开源的C#开发项目，是数据库文档生成工具。该项目遵守MIT开源协议。地址：https://gitee.com/dotnetchina/DBCHM。

工具从最初支持chm文档格式开始，通过开源，集思广益，不断改进，又陆续支持word、excel、markdown等文档格式的导出。

项目目标是：力求做最简单、最实用的数据库文档(字典)生成工具！

这个项目已经被dotNET China收录，成为一个很有前途的开源项目，并在Gitee上得到站点推荐，得到了1.8KStars。

二、使用范围

本工具支持的数据库有：SqlServer、MySQL、Oracle、PostgreSQL、DB2、SQLite等。

三、功能简介

文档的内容包含：

1、序号|列名|数据类型|长度|小数位数|主键|自增|允许空|默认值|列说明

2、视图 视图具体内容

3、存储过程 存储过程具体内容 🔹注：Oracle在v1.8.0.3-beta版本及以后暂不会查询显示自增数据。

4、支持导出文档格式有：chm、word、excel、pdf、html、xml、markdown

5、更新表列注释的方式： A．通过工具-批注上载，选择文件导入进行更新批注(注释)： pdm 由powerdesigner设计数据库时产生。 xml 由visual studio设置 实体类库的项目属性，勾选 XML文档文件 后生成项目时产生。 xml 由dbchm的 XML导出 而产生。 B．列批注 在编辑前的选中状态下，可以从 选定行开始 粘贴多行文本内容 对多个列注释批量赋值。

四、操作示例图示

DBCHM操作非常简单，一看菜单名称就明白大致操作流程，非常直观。在此不再赘述。下面上几张示例图。

1、数据库连接配置示例

2、数据库连接管理示例

3、表名模糊匹配

4、执行批注更新示例

5、执行导出CHM文件示例

6、生成内容效果示例

小北有话说

这个开源项目不光提供全部源代码，为了方便大家下载，还提供了可执行文件的下载。

有这个这么好用的工具，在项目开发过程中绝对会减轻非常多的工作量。所以指北君真的非常推荐这款小工具啦。还有，通过对源代码的学习，可以提高自己的水平。

开源指北，立志做最好的开源分享平台，分享有趣实用的开源项目。 欢迎加入交流群，你可以摸鱼、划水、吐槽、咨询。还有简历模板、各种技术面试资料等100G的资源等着你领取哦。

关注公众号开源指北，后台回复fff888马上加入，加入即送程序员进阶精品电子书一套，快来一起来聊一聊吧！

以上就是本次推荐的全部内容，我是源小北，感谢各位的观看。