rspec/rules/S2371/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

44 lines
872 B
Plaintext

== Why is this an issue?
Reserved parameters are unnecessary in VB.NET because method overloading can be used to introduce additional variants over time.
This rule detects parameters which contain ``++reserved++`` in their names.
=== Noncompliant code example
[source,text]
----
Module Module1
Function Add(ByVal a As Integer, ByVal b As Integer, ByVal reserved As Integer) As Integer ' Noncompliant
Return a + b
End Function
End Module
----
=== Compliant solution
[source,text]
----
Module Module1
Function Add(ByVal a As Integer, ByVal b As Integer) As Integer ' Compliant
Return a + b
End Function
End Module
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Remove "reserved" parameter "xxx".
endif::env-github,rspecator-view[]