Programmer Humor

19623 readers

7 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

[email protected]

1518

How programmers comment their code (lemmy.dbzer0.com)

submitted 4 months ago by [email protected] to c/[email protected]

146 comments fedilink hide all child comments

https://nitter.poast.org/denicmarko/status/1774077890281267451

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

[–] [email protected] 34 points 4 months ago (2 children)

Good code is self-explanatory. You should only comment your code if it does something unexpectedly complicated.

The code shows what is being done. The comments should explain the why.

[–] independantiste 14 points 4 months ago* (last edited 4 months ago) (1 children)

Yes. This 1000x. I hate it at work when I come across code that was written 3 years ago that has literally no traces of why it's there and a quick summary of what it does. Especially because that code is always the most abbreviated spaghetti you've ever seen. People should stop thinking (their) code documents itself because 99.999% of programmers cannot do it right.

I really like the Google way of coding: assume the person reading the code is the most 1337 programmer ever, BUT that this person knows absolutely nothing about the project

[–] [email protected] 7 points 4 months ago

Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.

[–] [email protected] 11 points 4 months ago

This is something a lot of people don't seem to understand. Even if code is self-explanatory, I want to know why it was designed that way.

I've fixed bugs where the fix was only a one line change, but it was extremely difficult to figure out, so I left a 10ish line comment above it explaining why it has to be done that way.