51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
75 lines
1.0 KiB
Plaintext
75 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^[a-z][a-zA-Z0-9]*$++``:
|
|
|
|
[source,java]
|
|
----
|
|
public void doSomething(int my_param) {
|
|
int LOCAL;
|
|
...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public void doSomething(int myParam) {
|
|
int local;
|
|
...
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Loop counters are ignored by this rule.
|
|
|
|
[source,java]
|
|
----
|
|
for (int i_1 = 0; i_1 < limit; i_1++) { // Compliant
|
|
// ...
|
|
}
|
|
----
|
|
as well as one-character ``++catch++`` variables:
|
|
|
|
[source,java]
|
|
----
|
|
try {
|
|
//...
|
|
} catch (Exception e) { // Compliant
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^[a-z][a-zA-Z0-9]*$
|
|
----
|
|
|
|
Regular expression used to check the names against.
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|