Skip to content

Commit

Permalink
Add docs for StringConcatToTextBlock
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 698226007
  • Loading branch information
cushon authored and Error Prone Team committed Nov 20, 2024
1 parent 4d239e8 commit be6e804
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/bugpattern/StringConcatToTextBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Using [text blocks] for strings that span multiple lines can make code easier to
read.

For example, prefer this:

```java
String message =
"""
'The time has come,' the Walrus said,
'To talk of many things:
Of shoes -- and ships -- and sealing-wax --
Of cabbages -- and kings --
And why the sea is boiling hot --
And whether pigs have wings.'
""";
```

instead of this:

```java
String message =
"'The time has come,' the Walrus said,\n"
+ "'To talk of many things:\n"
+ "Of shoes -- and ships -- and sealing-wax --\n"
+ "Of cabbages -- and kings --\n"
+ "And why the sea is boiling hot --\n"
+ "And whether pigs have wings.'\n";
```

[text blocks]: https://docs.oracle.com/en/java/javase/23/text-blocks/index.html

0 comments on commit be6e804

Please sign in to comment.