Navicat 怎么实现从ER图直接生成开发文档_通过导出模型报表功能实现

秋雪姑娘_7016

秋雪姑娘_7016

2026-04-26

205人浏览

原创

Navicat导出模型报表时字段注释不显示,是因为报表依赖数据库真实存储的COMMENT元数据,若MySQL/PostgreSQL未设置字段COMMENT或SQL Server未用sp_addextendedproperty添加,则报表中对应列为空白。

navicat 本身不提供“从 er 图一键生成完整开发文档(如含接口说明、业务规则、字段字典等)”的能力,导出模型报表 功能仅能输出结构化元数据清单,不是传统意义的开发文档,但它是目前最接近、且可直接复用的自动化出口。

导出模型报表时为什么看不到字段注释或业务说明

Navicat 的 导出模型报表 依赖数据库实际存储的元数据:只有当字段的 COMMENT 属性被真实写入(MySQL/PostgreSQL 支持,SQL Server 需用 sp_addextendedproperty),报表中才会显示。如果字段名是 user_name 但没设 COMMENT,报表里就只有一行空值或默认的“无”。

  • MySQL 检查方式:SHOW FULL COLUMNS FROM users; 看 Comment 列是否非空
  • PostgreSQL 检查方式:SELECT col_description('users'::regclass, attnum) FROM pg_attribute WHERE attrelid = 'users'::regclass AND attnum > 0;
  • 若 COMMENT 缺失,需先补全再执行逆向工程——否则报表里所有“描述”列都是空白

导出的 HTML/PDF 报表里中文乱码或表格错位

根本原因是 Navicat 报表模板使用固定字体链,且不嵌入字体。Windows 上若系统未启用 Microsoft YaHei 或 SimSun 作为默认 UI 字体,导出的 HTML 在 Chrome 中打开会回退到 Times New Roman,中文直接变方框;PDF 更严重,连字号都可能错位。

  • 临时修复:在 Navicat → 工具 → 选项 → 模型 → 报表 → 字体,手动指定为 Microsoft YaHei(Win)或 STHeiti(macOS),重启后重试
  • Linux 用户必须确保已安装 fonts-wqy-microhei,且 fc-list :lang=zh 能列出该字体
  • 避免用“打印为 PDF”按钮——它调用的是系统打印驱动,字体映射不可控;必须用 文件 → 导出 → 模型报表 路径

报表中缺少外键关系说明或索引信息

导出模型报表 默认只包含表、字段、主键三类基础项。外键约束、索引、检查约束、触发器等属于“高级对象”,需手动勾选才纳入:

navicatmysql
navicatmysql

Navicat For MySQL

下载
  • 导出前弹出的对话框里,展开 对象类型 区域,务必勾选 Foreign Keys、Indexes、Check Constraints
  • 若用的是逆向工程生成的模型(.nmf 文件),需确认逆向时勾选了 Include foreign keys 和 Include indexes,否则模型里压根没存这些信息
  • PostgreSQL 用户注意:视图、物化视图默认不参与报表导出,需单独在 对象类型 中启用 Views

如何把模型报表变成可用的开发文档初稿

导出的 HTML 报表本质是静态表格,不能直接当文档交付。真正能落地的方式是把它作为数据字典底稿,配合人工补充:

  • 用浏览器打开导出的 report.html,Ctrl+A 全选 → 粘贴进 Word 或 Notion,保留表格结构
  • 批量替换字段名中的下划线:比如 create_time → 创建时间(需提前维护好映射表)
  • 在“字段说明”列旁插入新列,手填业务含义,例如:status 行对应填“0-待审核,1-已通过,2-已驳回”
  • 导出的 Relationships 表只显示外键名和引用表,需人工补上语义,例如:order.user_id → users.id 补为“订单归属用户,级联删除”

别指望自动填充业务逻辑——那是 ER 图做不到的边界。模型报表的价值,在于把 80% 的结构定义固化下来,剩下 20% 的语义解释,必须由开发或产品补全。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3829

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2508

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1440

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1378

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1456

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2438

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

4100

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

19635

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

569

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习