this post was submitted on 24 Oct 2023

684 points (97.4% liked)

Programmer Humor

19497 readers

1261 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

684

I am God's greatest programmer (lemmy.world)

submitted 1 year ago by bigboismith@lemmy.world to c/programmer_humor@programming.dev

45 comments fedilink hide all child comments

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

[–] xmunk@sh.itjust.works 18 points 1 year ago (1 children)

The best explanation I've ever heard is:

Comments should state the 'Why' never the 'What'.

[–] hikaru755@feddit.de 1 points 1 year ago

There are some cases though where the code is just complicated for reasons outside of your control, in which case "what" comments are good - but they should never be taken at face value, but only used as a first step in understanding the code. There's a significant risk of the code not actually doing what the comment says.