rspec/rules/S101/vbnet/rule.adoc

66 lines
1.3 KiB
Plaintext
Raw Normal View History

== 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:
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
----
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]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== 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.
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]