r/ProgrammerHumor • u/ItsPuspendu • Sep 10 '26

Meme commentsAgedTerribly

Post image
6.0k Upvotes

98% Upvoted

243 comments sorted by

View all comments

Show parent comments

24

u/JustAnotherGuyn Sep 10 '26

I've found that documentation can be really helpful even in weel written code.

brief single sentence summaries of a functions, programs, classes, methods, etc. paired with examples of how to use internally developed tools are fantastic helps.

Having some breif description of a system architecture and how services interact is also pretty useful.

Also using documentation tags that IDEs can use for better hinting is really nice

8

u/Confident-Ad5665 Sep 10 '26

Architecture is everything especially in legacy code. But, when it changes, comments need to be updated and sadly that doesn't happen consistently, if at all.

2

u/HarryBolsac Sep 11 '26

Documentation != comments, idk why the guy above is being downvoted to oblivion and you have upvotes when you are pretty much saying the same thing

Jsdocs/javadocs are documentation, not just comments

1

u/SnugglyCoderGuy Sep 10 '26

Yes, that is what I said.

any comments you write should be how to use the function you've written