UDF - VS Code 开发助手插件
UDF 是一款专为 KSPB 项目开发团队设计的 VS Code 插件，提供代码导航、SQL 开发工具、DBF 文件处理、项目快捷操作等实用功能，帮助提升开发效率。
主要功能
1. 代码快速跳转
- 支持 SQL、C++、Delphi 代码的符号跳转
- 选中代码后按
Ctrl+Enter 快速跳转到定义
- 支持从剪贴板读取符号名称进行跳转
- 当剪贴板中是图片时，按
Ctrl+Enter 会将图片保存到临时目录，并把图片绝对路径写回剪贴板
- 模糊搜索符号名称，快速定位代码位置
- 同时支持 VS Code 原生跳转方式（
Ctrl+Click 或 F12）
2. SQL 开发工具
- SQL 语句追踪功能
- CDC 表变更监控
- C++ 代码中的 SQL 关键字高亮（可配置）
- 存储过程全局临时表转换
5. DBF 文件处理
- 右键点击 DBF 文件可直接编辑
- 支持比较两个 DBF 文件的差异
- 编辑后可保存回原格式
6. 项目快捷操作
- 一键打开前后端项目
- 编译后端 DLL（调试/发布模式）
- 编译前端 ClientDLL
- 附加到 KCBP 调试进程
- 自动化质量检查
7. 编辑器辅助
- 编辑器中选中文本后，右键选择
UDF::Copy With Details 可复制代码内容及文件路径、相对路径、行号、语言类型等上下文信息
快速开始
安装
- 下载
.vsix 文件
- 在 VS Code 中按
Ctrl+Shift+P 打开命令面板
- 输入 "Install from VSIX" 并选择下载的文件
基础配置
- 打开设置：
Ctrl+,
- 搜索 "UDF" 查看所有配置项
- 根据项目需求配置：
- 数据库连接：配置服务器地址、数据库名、用户名密码
- KCBP 环境：配置服务端路径、客户端路径、MSBuild 路径
- 质量检查：配置版本号、源码路径、发布路径
- 功能开关：按需启用 SQL 高亮、参数气泡等功能
常用快捷键
| 快捷键 |
功能 |
Ctrl+Enter |
代码跳转、执行自定义命令；剪贴板为图片时保存图片并复制图片路径 |
命令输入框
按 Ctrl+Enter 打开命令输入框，可以：
- 输入符号名称进行代码跳转
- 输入
@ 开头的命令执行自定义操作
常用命令
| 命令 |
说明 |
@config |
打开 UDF 设置 |
@trace |
开启/关闭 SQL 追踪 |
@reloadSymbols |
重新扫描代码符号 |
@openProject |
打开前后端项目 |
@autoQualityCheck |
执行质量检查 |
@buildLBMDLL |
编译后端 DLL |
@rebuildLBMDLL |
重新编译后端 DLL |
@buildClientDLL |
编译前端 ClientDLL |
@traceCppCall |
查找父级调用 DLL |
@lineConvert |
行转换工具（文件编码/格式） |
@attachToDebugKCBP |
附加到 KCBP 调试进程 |
配置项说明
数据库配置
| 配置项 |
说明 |
默认值 |
UDF.SQL.server_name |
数据库服务器地址，格式：主机名:端口 |
localhost:1433 |
UDF.SQL.database |
数据库名称 |
run |
UDF.SQL.user |
数据库登录用户名 |
sa |
UDF.SQL.password |
数据库登录密码 |
空 |
UDF.SQL.CDC_Monitor |
CDC 监控的表列表，多个表用逗号分隔 |
空 |
环境配置
| 配置项 |
说明 |
默认值 |
UDF.ENV.kcbp_path |
KCBP 服务端应用路径（用于编译和调试） |
空 |
UDF.ENV.Spbclient_path |
客户端应用路径（Spbclient） |
空 |
UDF.ENV.MSBuild_path |
MSBuild 编译器路径 |
空 |
UDF.ENV.KCBPAutoRun |
编译时是否自动启停 KCBP 服务 |
false |
质量检查配置
| 配置项 |
说明 |
默认值 |
UDF.AUTOQC.version |
当前项目版本号 |
6.6.8.0 |
UDF.AUTOQC.resourcePath |
功能号注册资源路径 |
空 |
UDF.AUTOQC.sourcePath |
当前版本源码路径 |
空 |
UDF.AUTOQC.lastSource |
上一版本源码路径（用于比对） |
空 |
UDF.AUTOQC.releasePath |
发布包输出路径 |
空 |
显示与功能开关
| 配置项 |
说明 |
默认值 |
UDF.BlueBuble.display |
启用 SQL 参数占位符气泡显示 |
false |
UDF.SQL.HighlightInCpp |
在 C++ 代码中高亮显示 SQL 关键字 |
false |
使用示例
代码跳转
方式一：选中跳转（推荐）
- 选中要查找的函数名或符号
- 按
Ctrl+Enter 直接跳转
方式二：从剪贴板跳转
- 复制要查找的符号名称到剪贴板
- 按
Ctrl+Enter 打开输入框
- 自动读取剪贴板内容，从列表中选择目标位置
方式三：手动输入跳转
- 按
Ctrl+Enter 打开输入框
- 输入符号名称进行搜索
- 从列表中选择目标位置
方式四：剪贴板图片转路径
- 复制一张图片到系统剪贴板
- 按
Ctrl+Enter
- 插件会将图片保存到系统临时目录，并把图片绝对路径写回剪贴板
- 保存成功后会弹出
图片路径已复制到剪贴板 提示
方式五：使用 VS Code 原生跳转
- 按住
Ctrl 点击符号名称
- 或将光标放在符号上按
F12
- 支持跳转到定义、查看引用等标准操作
复制代码上下文
- 在编辑器中选中文本
- 右键选择
UDF::Copy With Details
- 剪贴板中会写入代码内容及定位信息，格式包含
absPath、relPath、lines、language 和选中文本
执行自定义命令
- 按
Ctrl+Enter 打开输入框
- 输入
@ 开头的命令（如 @trace、@openProject）
- 按回车执行
编辑 DBF 文件
- 在资源管理器中右键点击
.dbf 文件
- 选择 "edit DBF"
- 在编辑器中修改内容
- 点击保存按钮保存回原格式
注意事项
- 插件在包含
server 目录的工作区中会自动启用完整功能
- 配置修改后无需重启 VS Code 即可生效
- 快捷键可在 VS Code 设置中自定义
版本信息
当前版本：0.1.1
0.1.1
- 新增
UDF::Copy With Details 编辑器右键菜单
- 新增剪贴板图片保存为临时文件并回写绝对路径
- 优化 ClientDLL 编译输出，显示实际工程路径
- 修复 ClientDLL 编译失败仍提示成功的问题
支持与反馈
如有问题或建议，请联系开发团队。
| |
