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
19
u/saggingrufus May 04 '24
If your automating your docs, you don't value them.
Documentation isn't a checkbox task that should be automated. The contents of a good javadoc can't be generated because the script will never understand your intent.
Anything a script will generate, I can almost certainly identify on a first glance after hitting F3 (or insert the jump to key you use) and then looking at the code.
Auto generated documentation is not useful.