rspec/rules/S4174/java/rule.adoc

55 lines
934 B
Plaintext
Raw Normal View History

== 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.
=== 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;
...
}
----
=== 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;
...
}
----
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[]