Visual Studio发送textDocument.documentSymbol请求的作用及结果查看方法

一、VS发送该请求时的具体操作 #

• VS会收集当前打开目标文档的文本内容、文档URI等核心信息，按照语言服务器协议（LSP）规范打包成JSON格式请求，发送给已注册的语言服务器。
• 触发时机通常包括：文档首次加载、文档内容修改后（部分场景下延迟触发）、用户手动刷新文档大纲时。

二、请求的核心用途 #

这是LSP定义的标准请求，核心目的是让语言服务器分析目标文档的代码结构，提取类、函数、变量、接口等符号信息，用来支撑VS的以下功能：

• 生成文档侧边栏的大纲导航（Outline）
• 支持编辑器内的符号跳转/搜索（比如Ctrl+Shift+F搜索符号、Ctrl+点击跳转）
• 提供代码折叠的依据（根据符号层级折叠代码块）

三、响应的使用方式 #

语言服务器需要返回符合LSP规范的DocumentSymbol[]或SymbolInformation[]结构数据：

• 每个符号需包含：名称、类型（类/函数/变量等）、所在文档的范围（起始行/列、结束行/列）、层级关系（比如类包含方法）
• VS收到响应后，会自动解析这些数据，填充到侧边栏大纲、符号搜索面板等UI组件中，同时关联到编辑器的对应代码位置。

举个简单的响应结构示例（JSON）：

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "name": "MyClass",
      "kind": 5, // 5代表类（LSP定义的SymbolKind枚举）
      "range": {
        "start": {"line": 5, "character": 0},
        "end": {"line": 20, "character": 1}
      },
      "selectionRange": {
        "start": {"line": 5, "character": 5},
        "end": {"line": 5, "character": 11}
      },
      "children": [
        {
          "name": "myMethod",
          "kind": 6, // 6代表方法
          "range": {
            "start": {"line": 10, "character": 2},
            "end": {"line": 15, "character": 3}
          },
          "selectionRange": {
            "start": {"line": 10, "character": 6},
            "end": {"line": 10, "character": 14}
          }
        }
      ]
    }
  ]
}

四、在Visual Studio 2022中查看请求结果 #

• 侧边栏大纲：打开目标文档后，点击编辑器右侧的“大纲”标签（或用快捷键Ctrl+M, O），就能看到解析后的符号层级结构，点击可直接跳转到对应代码位置。
• 符号搜索面板：按下Ctrl+Shift+O，输入符号名称，就能看到服务器返回的符号列表，选择后跳转至对应位置。
• 代码折叠：编辑器左侧会根据符号层级显示折叠箭头，点击可折叠/展开对应代码块，这也是基于该请求的响应数据实现的。
• 调试原始数据：在VS的“输出”窗口中，切换到对应语言服务器的输出频道，就能查看发送的请求JSON和返回的响应JSON内容（需要语言服务器开启日志输出，或VS启用LSP调试日志）。

内容的提问来源于stack exchange，提问作者infinitezero