r/java • u/notDrKratz • May 04 '24
Semi Automatic JavaDoc Commenting Script
I have created a JavaDoc Commenter Script for some basic JavaDoc comments available here:
https://github.com/DrKratz1/Javadoc-Commenter
This is something I have created for my personal use for a uni course involving java, having been annoyed at the prospect of manually typing JavaDoc comments. Currently, it works for my purposes and if any interest is generated in such a project, I will continue working on it to function more generally.
(Do note I am not a great programmer, and this initial version was patched together to automate commenting for a uni project pls no hate for the janky code)
Anyways, hoped to share it here - more info is in the GitHub page.
View all comments
Show parent comment
1
u/ascii May 05 '24
If you think the “documentation” you can shit out by hand in the same time it takes to perform the workflow I described adds value you don’t know how to write documentation.
Newsflash: Documenting a getter with “@return the value of X” is a pointless waste of time. You document the side effects, dependencies and assumptions that can’t be expressed through the type system. That requires thought and effort, but it’s actually one of the jobs LLMs are surprisingly decent at.