this post was submitted on 06 Jul 2024
847 points (100.0% liked)

Programmer Humor

421 readers
27 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
Feyter@programming.dev
anzo@programming.dev
BurningTurtle@programming.dev
pylapp@programming.dev
847
How programmers comment their code (lemmy.dbzer0.com)
submitted 4 months ago by Andromxda@lemmy.dbzer0.com to c/programmer_humor@programming.dev
46 comments fedilink hide all child comments
 

https://nitter.poast.org/denicmarko/status/1774077890281267451

you are viewing a single comment's thread
view the rest of the comments
[–] smeg@feddit.uk 38 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

[–] mundane@feddit.nu 8 points 4 months ago

Absolutely, although I see that as part of why

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

[–] sukhmel@programming.dev 4 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

[–] bleistift2@sopuli.xyz 3 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.”