Ignore

@Ignore annotation, used for ignoring inspection results at member and local level.


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

Parameters
NameTypeDescription
InspectionsParamArray (Identifier) This annotation optionally takes a comma-separated list of inspection names as argument. If no specific inspection is provided, then all inspections should ignore the annotated target.
Remarks

Use the @IgnoreModule annotation to annotate at module level.

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

Option Explicit
Private InternalState As VBA.Collection
'@Ignore
Public Sub DoSomething(ByRef foo As Long)
    foo = 42
End Sub
'@Ignore ProcedureNotUsed
Public Sub DoSomethingElse()
    '@Ignore VariableNotAssigned
    Dim result As Variant
    DoSomething result
    Debug.Print result
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