跳到正文

文档符号 ​

通过 textDocument/documentSymbol 提供文件大纲和面包屑导航:返回包含符号范围、选择范围以及 detail 字段的嵌套符号树,用来区分重载并展示所声明的类型。

符号层级 ​

符号在大纲中的嵌套关系与代码中一致:成员位于所属类之下,局部符号位于所属函数之下。

支持

嵌套作用域

命名空间、类及其成员在大纲中的嵌套关系与代码中一致

支持

作用域外定义(out-of-line definitions)

作用域外定义在其书写位置以限定名列出,重复打开的命名空间每次打开各列出一次

支持

匿名作用域与内联作用域

匿名命名空间、匿名结构体和匿名联合体将成员归在占位名称下,内联命名空间保留自身节点

局部符号

在函数体中声明的变量、类型和 Lambda 嵌套在该函数之下

支持

友元函数定义

在类内部定义的友元函数列在该类之下

支持

访问控制区段

成员按代码中的书写顺序列出;所属的 public 和 private 区段不单独构成大纲层级

宏声明的成员

单次宏调用以代码中未写出的名称声明的实体会列在该次调用之下,并带上实参中给出的名称(例如测试宏生成的测试、类宏添加的成员);只声明实参中所写名称的宏调用则直接按所写名称列出

符号种类 ​

每个符号列出时都会标明其种类,涵盖从命名空间、类到宏和模块声明的各类实体。

支持

核心符号种类

命名空间、类、联合体、枚举及其成员,以及函数、变量、字段、结构化绑定(structured bindings)和 Lambda 各自按其种类列出

支持

模板

类模板、函数模板和变量模板在详情中标明 template,其范围从 template 关键字开始;概念(concept)和简写函数模板也会列出

支持

模板特化与推导指引(deduction guides)

模板特化连同其模板实参和自身成员一起列出,推导指引则带上它推导出的签名

支持

类型别名

typedef 与 using 别名以及别名模板均作为类型别名列出

支持

显式实例化

类模板、函数模板和变量模板的显式实例化会列出,但不展开成员

宏

对象式宏和函数式宏均会列出,函数式宏还会将形参作为详情显示

支持

模块声明

模块单元会列出其声明或归属的模块

支持

包含指令

#include 指令不列入大纲;其文档链接可直接跳转到目标文件

支持

Pragma mark 分组

#pragma mark - Name 开启一个分组,将随后的符号归入其下

支持

命名空间别名

命名空间别名作为命名空间列出,详情显示为 namespace alias

支持

头文件保护宏(include guards)

包裹整个头文件的 #ifndef 与 #define 头文件保护宏不列入大纲

符号详情 ​

名称旁的 detail 用于区分重载,并展示变量所声明的类型。

函数签名

detail 字段显示函数的形参(含形参名)和返回类型,用以区分重载;构造函数不显示返回类型

支持

变量与字段类型

变量或字段将所声明的类型显示为详情,Lambda 则显示调用它时的形参与返回类型

支持

默认实参

函数的详情会列出各形参及其默认值

基类

派生类的详情按代码写法列出各个基类及其访问说明符

支持

带类作用域的类型

书写时带有类作用域的类型在详情中保留一次该作用域,依赖名也不例外

符号范围 ​

每个符号都带有完整声明的范围以及名称本身的范围,选中符号时编辑器会定位并选中名称范围。

支持

名称与声明范围

符号的范围覆盖整条声明,名称范围覆盖完整写出的名称,包括 ~Widget、operator== 和 operator bool

多行签名

跨越多行的声明范围从首行延伸至末行

宏展开产生的符号

宏调用所声明的符号列在宏调用处,而非宏定义处

宏实参中的名称

写在宏实参中的名称作为符号的名称范围;写在宏体中的名称则回退到宏调用处

符号标签 ​

标签用于将符号标为已弃用;成员的其他性质则体现在详情中。

支持

已弃用符号

已弃用的符号带有 Deprecated 标签,编辑器会为其加上删除线

支持

成员标记

成员带有 static、virtual 或 = 0 时会在详情中注明;协议的标签只表达弃用状态,访问权限不作显示