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.
62 lines
1.2 KiB
Plaintext
62 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all non-private fields names match a provided regular expression.
|
|
|
|
|
|
Note that this rule does not apply to non-private ``++Shared ReadOnly++`` fields, for which there is another rule.
|
|
|
|
|
|
The default configuration is:
|
|
|
|
* 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
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``:
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Public foo As Integer ' Noncompliant
|
|
End Class
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Public Foo As Integer ' Compliant
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this field to comply with the regular expression: "xxx".
|
|
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
|
----
|
|
|
|
Regular expression used to check the non-private field names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|