2023-05-03 11:06:20 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
2021-04-28 16:49:39 +02:00
|
|
|
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
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Noncompliant code example
|
2021-04-28 16:49:39 +02:00
|
|
|
|
|
|
|
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
|
|
|
----
|
|
|
|
Class Foo
|
|
|
|
Event fooEvent() ' Noncompliant
|
|
|
|
End Class
|
|
|
|
----
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Compliant solution
|
2021-04-28 16:49:39 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,vbnet]
|
2021-04-28 16:49:39 +02:00
|
|
|
----
|
|
|
|
Class Foo
|
|
|
|
Event FooEvent() ' Compliant
|
|
|
|
End Class
|
|
|
|
----
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2021-09-20 15:38:42 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
=== 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.
|
|
|
|
****
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|