ModuleDescription

@ModuleDescription annotation, indicates the presence of a VB_Description module attribute value providing a docstring for the module. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.


New This feature is currently only available in pre-release builds (or the xmldoc asset doesn’t yet exist on main!).

Parameters
NameTypeDescription
DocStringText 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.
Remarks

The @Description annotation cannot be used at module level. This separate annotation disambiguates any potential scoping issues that present themselves when the same name is used for both scopes. This documentation string appears in the VBE's own Object Browser, as well as in various Rubberduck UI elements.

Examples

Each example is a self-contained MCVE showing the feature in a single specific scenario.

Standard Module
Named Module1 by default, these are general-purpose standard procedural modules.
Class Module
Named Class1 by default, these modules define the default interface for an object of that type.
Predeclared Class
A class module with its VB_PredeclaredId attribute set to True (with or without a @PredeclaredId annotation).
Interface Module
Abstract interfaces are class modules (with or without an @Interface annotation) whose default interface is not a class type intended to be instantiated.
UserForm Module
A predeclared class with a design-time visual designer using the MSForms UI framework.
Document Module
Owned by the host application, these class modules belong to the host document and may handle various events fired by the host application.

Class1 (code pane)

'@ModuleDescription("Represents an object responsible for doing something.")
Option Explicit
Public Sub DoSomething()
End Sub

Class1 (synchronized, hidden attributes shown)

Attribute VB_Description = "Represents an object responsible for doing something."
'@ModuleDescription("Represents an object responsible for doing something.")
Option Explicit
Public Sub DoSomething()
End Sub

Back to list

The content of this page was generated from xml/comments in the source code compiled into Rubberduck.Parsing.xml. Edit this page