@VariableDescription annotation, indicates the presence of a VB_VarDescription attribute value providing a docstring for a module-level variable or constant (not local variables). Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
Name | Type | Description |
---|---|---|
DocString | Text | This string literal parameter does not support expressions and/or multiline inputs. The string literal is used as-is as the value of the hidden member attribute. |
The @VariableDescription annotation complements the @description annotation, which can be applied to methods. Having separate annotations for variables and members disambiguates any potential scoping issues presenting themselves when the same name is used for both scopes.
Each example is a self-contained MCVE showing the feature in a single specific scenario.
Module1
by default, these are general-purpose standard procedural modules.Class1
by default, these modules define the default interface for an object of that type.VB_PredeclaredId
attribute set to True
(with or without a @PredeclaredId
annotation).@Interface
annotation) whose default interface is not a class type intended to be instantiated.
The content of this page was generated from xml/comments in the source code compiled into Rubberduck.Parsing.xml
.
Edit this page