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.
63 lines
1.3 KiB
Plaintext
63 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all ``++Private++`` field names match the provided regular expression.
|
|
|
|
|
|
Note that this rule does not apply to ``++Private Shared ReadOnly++`` fields, which are checked by another rule.
|
|
|
|
|
|
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 Foo As Integer ' Noncompliant
|
|
End Class
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Private foo As Integer ' Compliant
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this field to match the regular expression "xxx".
|
|
|
|
|
|
=== 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" field names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|