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.
48 lines
813 B
Plaintext
48 lines
813 B
Plaintext
== Why is this an issue?
|
|
|
|
Specifying the default value for an annotation parameter is redundant. Such values should be omitted in the interests of readability.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
@MyAnnotation(arg = "def") // Noncompliant
|
|
public class MyClass {
|
|
// ...
|
|
}
|
|
public @interface MyAnnotation {
|
|
String arg() default "def";
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
@MyAnnotation
|
|
public class MyClass {
|
|
// ...
|
|
}
|
|
public @interface MyAnnotation {
|
|
String arg() default "def";
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|