AttributeValueOutOfSync

Indicates that the value of a hidden VB attribute is out of sync with the corresponding Rubberduck annotation comment.


Inspection type: CodeQualityIssues

Default severity: Warning

Reasoning

Keeping Rubberduck annotation comments in sync with the hidden VB attribute values, surfaces these hidden attributes in the VBE code panes; Rubberduck can rewrite the attributes to match the corresponding annotation comment

Quick-Fixes

The following quick-fixes are available for this inspection:

  • IgnoreOnce: Adds an '@Ignore annotation to ignore a specific inspection result. Applicable to all inspections whose results can be annotated in a module.
  • AdjustAttributeAnnotation: Adjusts existing Rubberduck annotations to match the corresponding hidden attributes.
  • AdjustAttributeValues: Adjusts existing hidden attributes to match the corresponding Rubberduck annotations.

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.

The following code should trigger this inspection:

Module1

'@Description("foo")
Public Sub DoSomething()
    Attribute VB_Description = "bar"
    ' ...
End Sub

Back to list

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