this post was submitted on 26 Nov 2023

709 points (89.3% liked)

Programmer Humor

19302 readers

1641 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

Keep content in english
No advertisements
Posts must be related to programming or programmer topics

founded 1 year ago

MODERATORS

Feyter@programming.dev

anzo@programming.dev

BurningTurtle@programming.dev

pylapp@programming.dev

709

Bill is a pro grammer (sh.itjust.works)

submitted 10 months ago by CowsLookLikeMaps@sh.itjust.works to c/programmer_humor@programming.dev

99 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] CowsLookLikeMaps@sh.itjust.works 3 points 10 months ago* (last edited 10 months ago)

Or you're stuck within the confines of a horrible legacy system which the business will not allow you the time to refactor/rewrite but still want your code to be somewhat readable.

But in general, I agree with your argument. When writing from scratch or improving reasonably well designed code, often documentation could be replaced by breaking it up into another function or naming variable better. It's a bit of a code smell for violating the SRP. And yet there are times that documentation is needed for the "why". Things are nuanced I guess.