2023-05-03 11:06:20 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
2023-06-08 08:03:28 +02:00
|
|
|
include::../description.adoc[]
|
2021-02-02 15:02:10 +01:00
|
|
|
|
2020-06-30 10:16:44 +02:00
|
|
|
The default configuration is the one recommended by Microsoft:
|
|
|
|
|
2023-06-08 08:03:28 +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 lowercased, e.g., `GetHtml`
|
2021-02-02 15:02:10 +01:00
|
|
|
|
2023-06-08 08:03:28 +02:00
|
|
|
For example, with the default regular expression ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``, the class:
|
2020-06-30 14:49:38 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,vbnet]
|
2020-06-30 10:16:44 +02:00
|
|
|
----
|
|
|
|
Class foo ' Noncompliant
|
|
|
|
End Class
|
|
|
|
----
|
|
|
|
|
2023-06-08 08:03:28 +02:00
|
|
|
should be renamed to
|
2020-06-30 10:16:44 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,vbnet]
|
2020-06-30 10:16:44 +02:00
|
|
|
----
|
2023-06-08 08:03:28 +02:00
|
|
|
Class Foo
|
2020-06-30 10:16:44 +02:00
|
|
|
End Class
|
|
|
|
----
|
2021-06-02 20:44:38 +02:00
|
|
|
|
2023-06-08 08:03:28 +02:00
|
|
|
== Resources
|
|
|
|
|
|
|
|
=== Documentation
|
|
|
|
|
|
|
|
* https://learn.microsoft.com/en-us/dotnet/visual-basic/programming-guide/program-structure/naming-conventions[Visual Basic Naming Conventions]
|
|
|
|
* https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions[Microsoft Capitalization Conventions]
|
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
=== Message
|
|
|
|
|
|
|
|
Rename this class to match the regular expression: "xxx".
|
|
|
|
|
|
|
|
|
|
|
|
=== Parameters
|
|
|
|
|
|
|
|
.format
|
|
|
|
****
|
|
|
|
_STRING_
|
|
|
|
|
|
|
|
----
|
|
|
|
^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
|
|
|
----
|
|
|
|
|
|
|
|
Regular expression used to check the class names against.
|
|
|
|
****
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2021-06-02 20:44:38 +02:00
|
|
|
== Comments And Links
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../comments-and-links.adoc[]
|
2023-06-22 10:38:01 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|