this post was submitted on 26 Nov 2023
3 points (100.0% liked)

Programmer Humor

19471 readers
1433 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
[–] philm@programming.dev 1 points 11 months ago (2 children)

Yeah, but unironic...

If your code needs comments, it's either because it's unnecessarily complex/convoluted, or because there's more thought in it (e.g. complex mathematic operations, or edge-cases etc.). Comments just often don't age well IME, and when people are "forced" to read the (hopefully readable) code, they will more likely understand what is really happening, and the relevant design decisions.

Good video I really recommend: https://www.youtube.com/watch?v=Bf7vDBBOBUA

[–] Pickle_Jr@lemmy.dbzer0.com 1 points 11 months ago

Yeah, another way I've heard it phrased is comments are for explaining why you did things a certain way, not for explaining what it's doing.

[–] Vilian@lemmy.ca 0 points 11 months ago* (last edited 11 months ago) (1 children)

and if you need an unnecessarily complex code for performance sake?

[–] hstde@feddit.de 0 points 11 months ago

There's a comment for you to explain the why.

Rule of thumb: code explains the how and what, comments explain the why.