2023-05-03 11:06:20 +02:00
== Why is this an issue?
2021-04-28 16:49:39 +02:00
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.
2021-04-28 18:08:03 +02:00
2023-05-03 11:06:20 +02:00
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
With the default regular expression ``++^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$++``:
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
public void doSomething() {
final int local = 42;
...
}
----
2021-04-28 18:08:03 +02:00
2023-05-03 11:06:20 +02:00
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
public void doSomething() {
final int LOCAL = 42;
...
}
----
2021-04-28 18:08:03 +02:00
2021-09-20 15:38:42 +02:00
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== 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.
****
2021-09-20 15:38:42 +02:00
endif::env-github,rspecator-view[]