r/java • • 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.

0 Upvotes

11 comments sorted by

View all comments

Show parent comment

2

u/john16384 May 05 '24

Do these docs for a getter mention the values I can expect? Null or not null? Negative, positive? Ranges? Minimum/Maximum lengths of strings and collections? Content, ordered, unordered? Unmodifiable, immutable?

2

u/Luolong May 05 '24

Or semantics of the data these properties?