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

Programmer Humor

19512 readers
366 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
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 11 months ago* (last edited 11 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
[–] Prunebutt@feddit.de 25 points 11 months ago (1 children)

Comments are lies that will happen sometime in the future

Comments are always overlooked if gode gets refactored. Language servers can't/won't parse them and they're easy to overlook.

If you name your functions/variables clearly, put complex logic into clearly named functions and keep the same level of abstraction in every function (which never exceeds roughly 50 lines), you hardly need any comments, if any.

Comments are for behavior that's not possible to convey clearly through code.

[–] Archive@lemmy.world 7 points 11 months ago

If a block of code needs a comment, then you can easily move that block into a function and summarise the comment into a name for that function. If you can not easily move a block of code into a function, then you may need to rethink your design.

This isn’t always true of course, but it’s a good mindset to have.