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.
60 lines
1.3 KiB
Plaintext
60 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all ``++Private Shared ReadOnly++`` field names comply with the provided regular expression.
|
|
|
|
|
|
The default configuration is:
|
|
|
|
* Optionally, can start with an underscore character or "s_", e.g. ``++_foo++``, ``++s_foo++``
|
|
* Camel casing, starting with a lower case character, e.g. backColor
|
|
* Short abbreviations of 2 letters can be capitalized only when not at the beginning, e.g. "id" in productID
|
|
* Longer abbreviations need to be lower cased, e.g. html
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^(s_|_)?[a-z][a-z0-9]*([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``:
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Private Shared ReadOnly Foo As Integer ' Noncompliant
|
|
End Class
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Private Shared ReadOnly foo As Integer ' Compliant
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename "xxx" to match the regular expression: "yyy".
|
|
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^(s_|_)?_?[a-z][a-z0-9]*([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
|
----
|
|
|
|
Regular expression used to check the "Private Shared ReadOnly" field names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|