rspec/rules/S5663/java/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

41 lines
780 B
Plaintext

== Why is this an issue?
If a string fits on a single line, without concatenation and escaped newlines, you should probably continue to use a string literal.
=== Noncompliant code example
[source,java]
----
String question = """
What's the point, really?""";
----
=== Compliant solution
[source,java]
----
String question = "What's the point, really?";
----
== Resources
* https://openjdk.java.net/jeps/378[JEP 378: Text Blocks]
* https://openjdk.org/projects/amber/guides/text-blocks-guide[Programmer's Guide To Text Blocks], by Jim Laskey and Stuart Marks
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Use simple literal for a single-line string.
endif::env-github,rspecator-view[]