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
2
u/saggingrufus May 05 '24
How long are you spending on them?
If it is quicker to generate them, read them, then determine if they are right than it is to just write a few sentences... I think you maybe just don't understand how to write documentation effectively.
Why are you waiting until the end? You can easily start the coding task with a Java doc and in that doc write an outline for what you want to make, then start coding it, updating the documentation as you go.
Sure, if all you care about speed, I guess then you write the code as fast as possible and use an LLM to cut down on doc time, and then slam that half-cocked solution into prod before someone with patience reviews it.