🎯 XML注释提取功能

自动化文档提取,提升工作效率

✨ 功能特性

📝 智能提取

自动从XML注释中提取说明信息,无需手动填写,提高工作效率。

👤 责任追踪

自动识别维护人员信息,方便问题追溯和协作管理。

📊 数据导出

提取的信息直接集成到数据导出功能中,支持自定义配置。

🔄 向下兼容

不影响现有功能,无注释时字段保持为空,完全兼容旧数据。

📖 使用说明

  1. 编写XML注释

    在每个<struct>标签前添加注释,包含表说明和维护人员信息:

    XML示例
    <!--//////////////////////////////////////////////
      ///////系统状态表  用于系统监控 jack////////////
     /////////////////////////////////////////////////-->
    <struct name="systemstatus" version="1" desc="(必填)系统状态日志,每分钟一条">
        <!-- 字段定义 -->
    </struct>
  2. 上传并解析XML

    在工具中上传XML文件,点击"解析XML"按钮进行解析。

  3. 配置导出选项

    点击"下载数据"按钮,在弹出的配置对话框中确保勾选:

    • ☑️ 说明信息
    • ☑️ 维护人员
  4. 导出数据文件

    确认配置后导出,数据文件中会自动包含提取的注释信息。

📋 导出效果对比

表名 事件说明 说明信息 维护人员 字段名 字段类型
systemstatus (必填)系统状态日志 系统状态表 用于系统监控 jack jack
dtEventTime datetime
AppID string
ServerID string

💡 注释格式建议

推荐格式:
[表名说明] [用途说明] [维护人员]
格式示例
✅ 系统状态表  用于系统监控 jack
✅ 用户登录日志  用于分析登录行为 mark
✅ 资源消耗表  用于分析资源使用情况 anna
提取规则:
说明信息:提取注释中的全部文本内容(清理分隔符后)
维护人员:提取注释中最后一个英文单词

🔍 技术细节

正则匹配

使用正则表达式精确定位struct标签前的注释块,确保准确提取。

文本清理

自动清理注释符号、分隔线和多余空格,保留核心信息。

容错处理

无注释或格式不规范时不会报错,相关字段保持为空。

配置持久化

导出配置保存到本地,下次使用时自动恢复设置。

📦 资源信息

示例XML文件

example.xml - 包含注释示例的XML文件

使用文档

查看完整文档