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.
62 lines
1.3 KiB
Plaintext
62 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default threshold of 3:
|
|
|
|
[source,java]
|
|
----
|
|
public void run() {
|
|
prepare("action1"); // Noncompliant - "action1" is duplicated 3 times
|
|
execute("action1");
|
|
release("action1");
|
|
}
|
|
|
|
@SuppressWarning("all") // Compliant - annotations are excluded
|
|
private void method1() { /* ... */ }
|
|
@SuppressWarning("all")
|
|
private void method2() { /* ... */ }
|
|
|
|
public String method3(String a) {
|
|
System.out.println("'" + a + "'"); // Compliant - literal "'" has less than 5 characters and is excluded
|
|
return ""; // Compliant - literal "" has less than 5 characters and is excluded
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
private static final String ACTION_1 = "action1"; // Compliant
|
|
|
|
public void run() {
|
|
prepare(ACTION_1); // Compliant
|
|
execute(ACTION_1);
|
|
release(ACTION_1);
|
|
}
|
|
----
|
|
|
|
include::../exceptions.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../parameters.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|