Comment alignment when saved
Closed this issue · 7 comments
When saving, java document comments are automatically aligned, parameter comments that do not exist are automatically added, and redundant ones are automatically deleted
When saving, java document comments are automatically aligned, parameter comments that do not exist are automatically added, and redundant ones are automatically deleted
Yeah depending on how you configured the plugin that is what it does.
What exactly now is the issue with that?
What I'm referring to in the figure is that the actual parameters on the Java Doc and method are automatically consistent
What I'm referring to in the figure is that the actual parameters on the Java Doc and method are automatically consistent
Okay I still can't quite follow what that has to do with the plugin as I can't find such an option in the plugin settings...
There is a JavaDoc section inside Settings > Editor > Code Style > Java:
Are you referring to this?
Because this is a built-in IDE option and not part of the plugin..
When a parameter in a method is missing in a Java doc, the @ param annotation will not be automatically added. I hope that the Save action plugin can automatically add the missing @ param in the Java doc or delete the @ param corresponding to the parameter that does not exist in the method when saving
I hope that the Save action plugin can automatically add the missing @ param in the Java doc or delete the @ param corresponding to the parameter that does not exist in the method when saving
- Is this a feature request?
- If so please describe this somewhere inside the issue, that you want functionality XY!
- The plugin is in maintenance mode; We usually don't do feature requests:
- The plugin usually just calls IntelliJ inspections. I couldn't find any inspection for your request so I don't think it can be implemented easily; However feel free to send a PR if you want to
- Not sure if this helps but Checkstyle has some JavaDoc configurations options. Maybe this is what you want...
Yes, this is a new function request, if the current project is only in the maintenance phase, then there is no way, thank you for your answer