rspec/rules/S1542/vbnet/rule.adoc

35 lines
1.1 KiB
Plaintext
Raw Normal View History

2020-06-30 12:47:33 +02:00
Shared naming conventions allow teams to collaborate efficiently. This rule checks that all subroutine and function names match a provided regular expression.
The default configuration is the one recommended by Microsoft:
* Pascal casing, starting with an upper case character, e.g. BackColor
* Short abbreviations of 2 letters can be capitalized, e.g. GetID
* Longer abbreviations need to be lower cased, e.g. GetHtml
* Event handlers with a handles clause and two-parameter methods with <code>EventArgs</code> second parameter are not covered by this rule.
== Noncompliant Code Example
With the default regular expression <code>^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$</code>
----
Module Module1
Sub bad_subroutine() ' Noncompliant
End Sub
Public Function Bad_Function() As Integer ' Noncompliant
Return 42
End Function
End Module
----
== Compliant Solution
----
Module Module1
Sub GoodSubroutine() ' Compliant
End Sub
Public Function GoodFunction() As Integer ' Compliant
Return 42
End Function
End Module
----