Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.

层级

  • DocumentSymbol

索引

Constructors(1)

Properties(7)

Constructors(1)

constructor

  • Creates a new document symbol.

    Parameters

    • name: string

      The name of the symbol.

    • detail: string

      Details for the symbol.

    • kind: SymbolKind

      The kind of the symbol.

    • range: Range

      The full range of the symbol.

    • selectionRange: Range

      The range that should be reveal.

    Returns DocumentSymbol

Properties(7)

name

name: string

The name of this symbol.

detail

detail: string

More detail for this symbol, e.g. the signature of a function.

kind

The kind of this symbol.

Optional tags

tags: readonly Deprecated[]

Tags for this symbol.

range

range: Range

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

selectionRange

selectionRange: Range

The range that should be selected and reveal when this symbol is being picked, e.g. the name of a function. Must be contained by the range.

children

children: DocumentSymbol[]

Children of this symbol, e.g. properties of a class.

友链:VS Code 中文文档 | VS Code 官网文档 | VS Code 扩展市场

Generated by TypeDoc. Maintained by 洛竹