this post was submitted on 06 Jul 2024
1547 points (99.4% liked)

Programmer Humor

19480 readers
1488 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

founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 63 points 4 months ago* (last edited 4 months ago) (3 children)

The allowable exception is when the what is a what the fuck, as in you had to use a hack so horrible that it requires an apology comment

[–] [email protected] 15 points 4 months ago

Absolutely, although I see that as part of why

Why is there a horrible hack here? Because stupid reason...

[–] [email protected] 5 points 4 months ago

Or if the what is so cryptic and esoteric that it would require the reader a couple hours of research to understand it.

Also, I find it useful to summarise the what before code blocks if that can't be summarised in a function name

[–] [email protected] 4 points 4 months ago

Describing the what also helps when you dabble in a new technology or little-used technology. It helps to explain to yourself what you’re doing and it helps in onboarding. “Hey, newbie, there’s a function in XYZ module that’s extensively documented. Look there for guidance.”