Unrecognized Annotation

Flags comments that parsed like Rubberduck annotations, but were not recognized as such.

Reasoning

Other add-ins may support similar-looking annotations that Rubberduck does not recognize; this inspection can be used to spot a typo in Rubberduck annotations.

Default severity

Warning

Inspection type

CodeQualityIssues

Examples

This example should trigger a result

MyModule (StandardModule)
'@Param "Value", "The value to print." : Rubberduck does not define a @Param annotation Public Sub Test(ByVal Value As Long) Debug.Print Value End Sub

This example should NOT trigger a result

MyModule (ClassModule)
'@Description "Prints the specified value." : Rubberduck defines a @Description annotation Public Sub Test(ByVal Value As Long) Debug.Print Value End Sub

Rubberduck.CodeAnalysis.Inspections.Concrete.UnrecognizedAnnotationInspection.cs (Prerelease-v2.5.9.6289)