rspec/rules/S5665/java/rule.adoc

50 lines
911 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
The use of escape sequences is mostly unnecessary in text blocks.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
``++\n++`` can be replaced by simply introducing the newline, ``++\"\"\"++`` it is sufficient to escape only the first qoute.
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
String textBlock = """
\"\"\" this \nis
text block!
!!!!
""";
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
String textBlock = """
\""" this
2021-04-28 16:49:39 +02:00
is
text block!
!!!!
""";
----
== Resources
2021-04-28 16:49:39 +02:00
* 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
Remove this unnecessary escape sequence
endif::env-github,rspecator-view[]