Use {@code} instead of HTML entities in Javadoc
#28821
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
|
Note that this is only possible in inline code blocks because indentation and line breaks are lost with |
marcwrobel
changed the title
{@code} instead of HTML entities in Javadoc
Special characters, like < or >, don't need to be escaped in {@code} Javadoc tag (https://reflectoring.io/howto-format-code-snippets-in-javadoc/). Using {@code} improves readability of the Javadoc in code.
|
It seems checkstyle does not like tags in |
snicoll
removed
the
status: waiting-for-triage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Special characters, like < or >, don't need to be escaped in
{@code}Javadoc tag (https://reflectoring.io/howto-format-code-snippets-in-javadoc/). Using{@code}improves readability of the Javadoc in code.