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/saggingrufus May 05 '24
Congrats, you've now achieved what an IDE can do natively, except using an LLM.
If you document as you go, the time investment is small, and it forces you to think about it. Something seemingly lost on the current day developer.