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.
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
The default configuration is the one recommended by Microsoft:
2020-06-30 14:49:38 +02:00
2020-06-30 12:47:33 +02:00
* 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
2021-01-27 13:42:22 +01:00
* Event handlers with a handles clause and two-parameter methods with ``++EventArgs++`` second parameter are not covered by this rule.
2020-06-30 12:47:33 +02:00
== Noncompliant Code Example
2021-01-27 13:42:22 +01:00
With the default regular expression ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``
2020-06-30 14:49:38 +02:00
2020-06-30 12:47:33 +02:00
----
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
----
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]