code-details README

定义函数的参数信息和返回信息等 可以定义并显示对象访问如props.catMap.setFitView的参数提示，无需到.min.js定义

使用方法

1. 打开 VS Code 设置：

   • 通过 File > Preferences > Settings 或 打开插件页面->点击齿轮->选择扩展设置->点击"在setting.json编辑"。

2. 搜索配置项：

   • 搜索 functionHover.functionDescriptions 来找到自定义函数描述的配置项。

3. 添加或修改描述：

   • 在设置中添加自定义函数描述或修改现有描述。格式应遵循 JSON 对象格式。

   {
       "functionHover.functionDescriptions": {
         "setFitView": "```typescript\nfunction setFitView(context: any): void\n```\nAdjusts the map view to fit all overlays.\n\n@param `context` — The context parameter.\n\n@returns\nThis method returns nothing.",
         "newFunction": "Description for a new function."
       }
   }
   

   从.md读取和写入：

   {
      "functionHover.markdownFilePath": "path/to/descriptions.md"
   }
   
   
   

functionHover.markdownFilePath 自定义.md格式如下（回车换行别忽略了） markdown函数被渲染颜色是使用代码标识typescript，参数背景是使用上标符号`

函数名：每个函数的描述都以 ### 函数名 开头，便于解析器识别每个函数块的起点。

代码块 (typescript)：函数的签名或代码块被包含在 typescript 内，以便它在 Hover 提示中被渲染为代码。

(descriptions.md)

\#\#\# setFitView

\`\`\`typescript

function setFitView(overlays: Array): void
\`\`\`
@param \`overlays\` (Array<Overlay>) - 覆盖物

@param \`immediately\` (Boolean = false) - 是否立即过渡

@param \`avoid\` (Array<Number> = [60,60,60,60]) - 四周边距，上、下、左、右

@param \`maxZoom\` (Number = zooms[1]) - 最大 zoom 级别

\#\#\# setFitView2

\`\`\`typescript

function setFitView(overlays: Array): void
\`\`\`
@param \`overlays\` (Array<Overlay>) - XXXXXXXXXXXXXXX

@param \`immediately\` (Boolean = false) - DDDDDDDDDDDDDDDDDDDDD

@param \`avoid\` (Array<Number> = [60,60,60,60]) - FFFFFFFFFFFFFFFFFFFF

@param \`maxZoom\` (Number = zooms[1]) - 最大 zoom 级别

使用逻辑

1. 读取外部文件：插件启动时或用户 Hover 时会尝试读取 markdownFilePath 指定的 .md 文件。
2. 解析文件内容：使用正则表达式将 Markdown 文件中的内容解析为一个对象，每个函数名称对应一个描述。
3. 显示优先级：如果外部文件中找到了对应的函数描述，则优先使用外部文件内容；否则，使用 settings.json 中的默认描述。