Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for StringConcatToTextBlock #4692

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading