288
10 months later bill revisits his spaghetti code. forgets absolutely everything and refuses to elaborate. this wouldn't have happened if Bill forgot to comment on his code (lemmy.world)
submitted 9 months ago* (last edited 9 months ago) by ShitOnABrick@lemmy.world to c/programmer_humor@programming.dev
40 comments fedilink hide all child comments
you are viewing a single comment's thread
view the rest of the comments
[-] Zagorath@aussie.zone 5 points 9 months ago

Comments explain why, not what. Any comments that explain what a section of code is doing would probably be better off as separated methods.

Apart from basic documentation comments, like JavaDoc or C#'s XML documentation comments.

[-] SpeakinTelnet@programming.dev 4 points 9 months ago

There's nothing limiting what a comment should be as far as I know.

As an example of what I mean, I've seen in a 10k+ lines python code a few lines of bit manipulation. There was a comment explaining what those lines did and why. They didn't expect everyone to be proficient in bit manipulation but it made it so that anyone could understand anyway.

[-] Zagorath@aussie.zone 2 points 9 months ago

There’s nothing limiting what a comment should be as far as I know.

Nothing technical, sure. Just good coding practices.

this post was submitted on 27 Nov 2023
288 points (91.6% liked)

Programmer Humor

19190 readers
1303 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