Quick documentation (hover)¶
Hovering over a symbol shows its signature, type and the description from doc comments.
Shortcut: mouse hover
Quick documentation on hover¶
The cursor hovers over a method call in the module code. The popup shows the method's signature and its description from the doc comment.
For an application method, hover also shows compilation contexts: the intersection of module flags, the method directive and the preprocessor condition surrounding its declaration. For example, a client method under #If WebClient lists only the web client. Same-named declarations in separate branches retain their own contexts.
The Server call note appears when a transition to the method's server context is possible. It accounts for form or command directives, common module exports and the Server call flag, and the declaration condition. The MethodCallUnavailable diagnostic separately checks whether a particular procedure may make a particular call.
This information describes the method's capabilities independently of enabled diagnostics and their selected checking modes. File-mode variants are listed separately when availability is limited to them. No 1C compilation-context section is added for unknown preprocessor conditions, missing module information or OneScript. A provably excluded declaration is shown as having no compilation contexts.
Hover on a variable¶
The cursor hovers over a variable in the module code. The popup shows the variable name and the inferred type of its value.
When the called function's body is available, its return type is refined using the calling method's context and preprocessor branch.
If an &AtClientAtServerNoContext function returns a number under #If Server and a string under #Else,
by default the receiving variable has type String in a client procedure and Number in a server procedure.
With the shared supportThickClientFileMode setting enabled, the client result
also includes Number: in a file-mode thick client, Server is true even inside a client form procedure.
The same setting applies to method context descriptions and inlay hints.
Hover on a platform method¶
The cursor hovers over the platform function СтрДлина in the code. The popup shows its signature, return type and description from the platform documentation.
Hover on a OneScript class constructor¶
The cursor hovers over a OneScript class constructor in a Новый expression. The popup shows the constructor's signature and the class description.
Hover on a keyword¶
The cursor hovers over a language keyword in the module code. The popup shows the description of that keyword.
Variable type inferred from a structure field¶
The cursor hovers over the variable НомерЗаказа, assigned from Заказ.Номер. The popup shows the type Строка, inferred from the structure field's description in the BSLDoc comment.
Variable type inferred from an expression¶
The cursor hovers over the variable Количество, assigned the result of Массив.Количество(). The popup shows the type Число, inferred from that expression.
Hover on a common module¶
The cursor hovers over a common module name in the code. The popup shows its name, description, module flags and return-value reuse setting.
OneScript: hover on an annotation¶
The cursor hovers over a usage of the &Кэшировать annotation in a OneScript module. The popup shows the description of that annotation.