MisleadingByRefParameter

Flags the value-parameter of a property mutators that are declared with an explict ByRef modifier.


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

Inspection type: CodeQualityIssues

Default severity: Warning

Reasoning

Regardless of the presence or absence of an explicit ByRef or ByVal modifier, the value-parameter of a property mutator is always treated as though it had an explicit ByVal modifier. Exception: UserDefinedType and Array parameters are always passed by reference

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.
  • IgnoreInModule: Adds an '@IgnoreModule annotation to ignore a inspection results for a specific inspection inside a whole module. Applicable to all inspections whose results can be annotated in a module.

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 NOT trigger this inspection:

MyModule

Private fizzField As Long
Public Property Get Fizz() As Long
    Fizz = fizzField
End Property
Public Property Let Fizz(arg As Long)
    fizzField = arg
End Property

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