MinHover

一个轻量级的 VS Code 扩展，为 SQL 关键词提供智能悬停提示。

✨ 功能特性

• 智能悬停: 悬停 SQL 关键词显示详细说明
• 双格式支持: 支持单行和多行两种 TIP 格式
• 自动更新: 保存文件时自动刷新提示
• 文件隔离: 每个文件的提示独立显示
• 轻量级: 性能影响最小

🚀 快速开始

1. 选择合适的 TIP 格式

MinHover 支持两种格式，您可以根据需要选择：

单行格式 - 适合简短说明

--# TEMP_USER: 用于存储非三方用户数据

SELECT * FROM TEMP_USER;

多行格式 - 适合详细描述

--# REPORT_LIST:
/*
用于生成汇报线
包含人员：非三方用户，某BU
汇报线生成逻辑：
- 如果有岗位以岗位优先
- 人员状态需非有效
*/
--#

SELECT * FROM REPORT_LIST;

2. 生成悬停提示

保存即自动生成 或按 Ctrl+Shift+P 运行：MinHover: Generate Tips from SQL Files

3. 享受悬停提示

将鼠标悬停在关键词上即可看到带有 SQL 语法高亮的提示信息。

📋 TIP 格式详解

单行格式

--# 关键词: 说明内容

特点：

• ✅ 简洁明了，一行搞定
• ✅ 适合简短的说明和提示
• ✅ 不影响代码阅读流畅性

多行格式

--# 关键词:
/*
详细的说明内容
支持多行文档
可以包含代码示例
*/
--#

特点：

• ✅ 支持详细的文档说明
• ✅ 可以包含格式化的代码示例
• ✅ 适合复杂业务逻辑说明

⚙️ 配置选项

🎯 可用命令

🔧 工作原理

1. 扫描: 遍历工作区中的所有 .sql 文件
2. 识别: 自动识别单行（--# 关键词: 内容）和多行（--# 关键词: /* 内容 */ --#）格式
3. 解析: 提取关键词和对应的说明内容
4. 生成: 创建 .vscode/hover-notes.json 文件
5. 隔离: 每个文件的提示只在该文件中显示
6. 悬停: 鼠标悬停时显示带语法高亮的提示

🆘 常见问题

Q: 两种格式可以混合使用吗？ A: 可以！您可以在同一个文件中同时使用单行和多行格式。

Q: 如何选择使用哪种格式？ A:

• 简短说明（一句话）→ 单行格式
• 详细文档、代码示例 → 多行格式

Q: 格式写错了会怎样？ A: 解析器会跳过格式不正确的 TIP 块，并在日志中显示警告信息。

Q: 为什么悬停提示没有显示？ A: 请检查：

• TIP 格式是否正确
• 是否运行了 "Generate Tips from SQL Files" 命令
• 关键词拼写是否与定义一致

Q: 可以在其他文件中看到其他文件的提示吗？ A: 不可以，MinHover 采用文件隔离机制，确保每个文件的提示独立显示。

📝 格式速查

-- 单行格式
--# 关键词: 说明内容

-- 多行格式
--# 关键词:
/*
详细说明内容
可以多行
支持代码示例
*/
--#