DEV Community

Discussion on: Don’t comment your code

Collapse
miguelmj profile image
MiguelMJ

Javadocs are just clutter

I can't 100% disagree with that, but after all those comments are made for automatic documentation generation. Sometimes I have found myself writing some redundant comments that, in the end, are only there so that the generated docs are complete. These are the ones I will be revisiting, not the comments themselves.
What do you think?

With the rest of points, I completely agree 😄

Collapse
aarone4 profile image
Aaron Reese

Yup. Javadocs are there to create the details of your API inputs and outputs. They are not redundant, but actually essential and must be up to date.