rspec/rules/S2343/vbnet/rule.adoc

45 lines
922 B
Plaintext
Raw Permalink Normal View History

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all enumeration value 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
=== Noncompliant code example
With the default regular expression ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``:
[source,vbnet]
----
Enum Foo
fooValue ' Noncompliant
End Enum
----
=== Compliant solution
[source,vbnet]
----
Enum Foo
FooValue ' Compliant
End Enum
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
endif::env-github,rspecator-view[]