Repository navigation
Conversation
Add a new property 'packageMethodCommentRequirement' to the CommentRequired rule that controls whether Javadoc comments are required (or unwanted) for package-private methods and constructors. Previously only public and protected methods could be configured via publicMethodCommentRequirement and protectedMethodCommentRequirement. The new property defaults to Ignored to keep existing configurations backwards compatible. It uses ASTExecutableDeclaration.getVisibility() == V_PACKAGE, which correctly detects package-private visibility and reliably resolves the attached Javadoc via node.getJavadocComment().
legacynode
force-pushed
the
feature/comment-required-package-visibility
branch
from
July 15, 2026 09:53
fc40396 to
8a54e3b
Compare
Contributor
|
Compared to main: (comment created at 2026-07-15 15:50:04+00:00 for 8a54e3b) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Describe the PR
Rule: CommentRequired
This PR adds a new property
packageMethodCommentRequirementto theCommentRequiredrule. It controls whether Javadoc comments are required (or unwanted) for package-private methods and constructors.Previously, method/constructor comment requirements could only be configured for
public(publicMethodCommentRequirement) andprotected(protectedMethodCommentRequirement) visibility. Package-private members were silently ignored, with no way to enforce documentation on them.Implementation notes:
ASTExecutableDeclaration.getVisibility() == V_PACKAGE, which correctly distinguishes genuinely package-private members frompublic/protectedmembers that merely reside in a package-private class.getJavadocComment()mechanism, consistent with how the other visibility levels are handled.Ignored, so existing rule configurations are completely unaffected and no new violations appear for current users.Note: this is distinct from the package-level Javadoc idea discussed in #1683 — that concerned
package-info.java, whereas this targets package-private methods and constructors.Related issues
No dedicated issue yet; happy to open one or start a discussion if preferred.
Ready?
./mvnw clean verifypasses