rspec/rules/S2367/vbnet/rule.adoc

43 lines
948 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all non-private ``++Const++`` field names comply with the 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
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
With the default regular expression ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``:
2022-02-04 17:28:24 +01:00
[source,vbnet]
2021-04-28 16:49:39 +02:00
----
Module Module1
Public Const foo = 0 ' Noncompliant
End Module
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,vbnet]
2021-04-28 16:49:39 +02:00
----
Module Module1
Public Const Foo = 0 ' Compliant
End Module
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
include::parameters.adoc[]
endif::env-github,rspecator-view[]