16f6c0aecf
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.
59 lines
1.1 KiB
Plaintext
59 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all even 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]
|
|
----
|
|
Class Foo
|
|
Event fooEvent() ' Noncompliant
|
|
End Class
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Event FooEvent() ' Compliant
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this event to match the regular expression: "xxx".
|
|
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
|
----
|
|
|
|
Regular expression used to check the event names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|