Require deprecation annotation on deprecated methods #21411
Merged
Conversation
This file contains 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
Item documented with a `@deprecated` javadoc note should be annotated with `@Deprecated` for the deprecation to be fully effective for API consumers.
JLS allows for a non-public class to be defined in a file with name not matching the class name. However, doing so reduces code readability. The source file name should match the name of the top-level class it contains.
Per `@Deprecated` javadoc, annotation on a local variable declaration or on a parameter declaration has no effect.
"deprecation" is the correct spelling.
findepi
force-pushed
the
findepi/deprecations
branch
from
c461204 to
0b21efe
Compare
`BigDecimal#equals` has surprising behavior: it also compares scale. `a.compareTo(b) == 0` should be used instead.
findepi
force-pushed
the
findepi/deprecations
branch
from
0b21efe to
f38cfc9
Compare
hashhar
approved these changes
Apr 5, 2024
wendigo
approved these changes
Apr 5, 2024
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.
Item documented with a
@deprecatedjavadoc note should be annotated with@Deprecatedfor the deprecation to be fully effective for API consumers.