-
-
Notifications
You must be signed in to change notification settings - Fork 706
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
Missing consistent order of Javadoc tags #3469
Comments
Hey! I've started working on this issue on this PR here, and have mentioned something on the PR and will mention it here just to see where people stand. In the Oracle Javadoc, it mentions a convention around multiple |
@PhilipIngham thanks for jumping on it!
Sounds sensible to me. Do you already know how to enforce these rules in an automated way? |
Not really, no. At the moment I'm just going through everything manually using regex to fix the stuff that's out of place in the tags, but I'll definitely need some help and/or time to figure out how to get the automation down. |
I was checking what Checkstyle offers and spotted the following: |
Checked this out and looks really useful, I will try and implement it :) Thanks for the assistance |
According to Oracle, the Javadoc order of tags should be the following:
@author
@version
@param
@return
@exception
/@throws
@see
@since
@serial
@deprecated
Other than fixing the existing order, we should have an automated way to enforce it, maybe via Spotless or the
maven-javadoc-plugin
.The text was updated successfully, but these errors were encountered: