this post was submitted on 24 Oct 2023
711 points (97.6% liked)

Programmer Humor

19817 readers
47 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 2 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[โ€“] [email protected] 18 points 1 year ago (1 children)

The best explanation I've ever heard is:

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

[โ€“] [email protected] 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.