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.
61 lines
1006 B
Plaintext
61 lines
1006 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public class A {
|
|
public static int counter = 0;
|
|
}
|
|
|
|
public class B {
|
|
private A first = new A();
|
|
private A second = new A();
|
|
|
|
public void runUpTheCount() {
|
|
first.counter ++; // Noncompliant
|
|
second.counter ++; // Noncompliant. A.counter is now 2, which is perhaps contrary to expectations
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public class A {
|
|
public static int counter = 0;
|
|
}
|
|
|
|
public class B {
|
|
private A first = new A();
|
|
private A second = new A();
|
|
|
|
public void runUpTheCount() {
|
|
A.counter ++; // Compliant
|
|
A.counter ++; // Compliant
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Change this instance-reference to a static reference.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|