数据库文档产生器使用说明书

1、数据库文档产生器使用说明书2013-6-21版权所有 朱盛文1 产生背景随着软件复杂度的增加，软件开发过程中，文档显得尤为重要。本款软件可以根据用户事先定义的WORD文档结构产生WORD数据库说明文档。详细操作见下文。2 系统要求.NetFrameWork2.03 详细操作1. 快捷键F1:连接数据库F2:设置是否自动提交更改F3:单表输出建库脚本F4:输出数据库全部建库脚本F5:刷新当前数据F6:生成当前表文档F7:生成库中所有文档F8:显示/隐藏代码模板F9:单表生成代码F10:生成库中所有代码F11:查看上一张表F12:查看下一张表Ctrl+S：

2、保存当前数据到数据库中的注释Ctrl+Shift+S：保存加载Word数据源到数据库Ctrl+D/T：切换数据源Ctrl/Shift+F5：重新加载Word数据源Ctrl+P：终止加载Word数据源Ctrl+Q：退出2. 界面简介1.设置区2.模板设置区（Word）2. 操作区3.显示区1. 连接数据库1.数据库类型支持1.MySql 2.Oracle 3.SqlServer2.分别填上对应的不同的连接字符串例如MySql: server= localhost;User Id= root;password=admin;Persist Security Info=True;port=3306;d

3、atabase=test;charset=gbk;Oracle: data source=ORCL;user id=GPS;password=GPS;SqlServer:Server= localhost;database=Test;uid=sa;pwd=1233.当数据类型和字符串填写完毕，即可连接数据库点击即可连接数据库连接前连接后2. Word必须文档设置输入设置，数据库word描述文档，它可以充当数据源，当切换数据源为文件时，自动加载。模板设置，在输出前规定word文档的格式。双击输入框可以直接选择文件，可以将word文档直接拖入文本框，单击文件夹图标打开文档。当文档不满足条件时（不是

4、.doc后缀，或者文件不存在）会以粉红色标记错误。数据源示例图模板示例图模板说明：i自动增长序号I老序号0表名描述1表名称3. 输出操作数据库连接成功后，会出现上述图像分别为表的中文名称，刷新按钮，表的英文名称列表框，详细注释表格，状态栏（当前操作说明，数据源说明，自动保存注释说明，自动保存设置说明，数据库中的表个数，文件中的表个数，描述的自动数，当前系统时间）单击按钮或者按（F6）键将生成该表的描述文档，如下图注意：在生成文档之前确保所有Word文档内容都已经保存。在产生word文档时，Word程序被强制关闭，不保存将造成数据丢失！单击按钮或者按（F7）键将生成该库源中所有表的描述文档，详细

5、说明请查看模板设置。4. 回写操作回写是指将界面的改变的描述保存到数据库。表的描述有三个，表的中文名称，表的描述，表的备注；字段描述是以一个表格形式展示的，分别包括：中文名称，字段名称，数据类型，空否，约束条件，含义说明。注意，想立即保存改变的描述，请查看状态栏上的自动提交是否显示为On；若不行立即保存，可以在修改完成之后一次性保存，请按Ctrl+S。对于表的描述中，按上下键是按顺序切换表，按回车（Enter）是立即保存，当焦点失去时，如果自动提交为On，也会立即保存到数据库。你也可以直接单击将描述更改保存到数据库。5. 数据源设定你可以将数据源设定为数据库或者为文档。当数据源切换时，程序会自

6、动加载数据，你可以在状态栏查看进度。切换数据源的快捷键是Ctrl+T，重新载入Word数据源的快捷键是Ctrl+Shift+F5,停止加载数据源的快捷键是Ctrl+P。6. 过滤设定在生成Word文档时你可以进行一些过滤，让字段名称包含一些字符的表通过，进而产生文档。7. 获取建库脚本通过对建库脚本的操作你可以，获取建库的原始脚本，仅支持（MySql、Oracle）。可以是单表（当前界面上下沙的表）或者数据库的全部表。8. Word文档之间之间转换设定Word模板，将Word文档从一种格式转换成另外一种格式，输入文档中的表必须服从统一的格式：常数-C、变数-、数组-；代表数字，0代表汉字表名。您可以进行过滤设置，得到想要某些包含特定字段的表。9. 批量生产注释进行快速的将数据库中所有同名的字段注释成为一致的描述。说明：C-字段名称D-注释E-执行写入10. 结构化代码生成你可以利用表名称从数据库里批量或者单个的生成一些有用的代码。F8：打开/隐藏模板设置，当你设置之后不希望每次生成时弹出，可以