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.
38 lines
967 B
Plaintext
38 lines
967 B
Plaintext
== Why is this an issue?
|
|
|
|
There is no reason to concatenate literal strings. Doing so is an exercise is reducing code readability. Instead, the strings should be combined. Similarly, literal strings should not be ``++append++``ed to a ``++StringBuffer++`` or ``++StringBuilder++`` sequentially, but combined into one call.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
String message = "Hello " + "world" + "!"; // Noncompliant
|
|
StringBuilder sb = new StringBuilder();
|
|
sb.append("I'm pleased").append(" to meet you."); //Noncompliant
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
String message = "Hello world!";
|
|
StringBuilder sb = new StringBuilder();
|
|
sb.append("I'm pleased to meet you.");
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|