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.
55 lines
934 B
Plaintext
55 lines
934 B
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all local, ``++final++``, initialized, primitive variables, have names that match a provided regular expression.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$++``:
|
|
|
|
[source,java]
|
|
----
|
|
public void doSomething() {
|
|
final int local = 42;
|
|
...
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public void doSomething() {
|
|
final int LOCAL = 42;
|
|
...
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this local constant "XXXX" to match the regular expression: ${format}
|
|
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^[A-Z][A-Z0-9]*(_[A-Z0-9]+)$
|
|
----
|
|
|
|
Regular expression used to check the constant names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|