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] 28 points 4 months ago* (last edited 4 months ago) (1 children)

Comment should describe "why?", not "how?", or "what?", and only when the "why?" is not intuitive.

The problem with comments arise when you update the code but not the comments. This leads to incorrect comments, which might do more harm than no comments at all.

E.g. Good comment: "This workaround is due to a bug in xyz"

Bad comment: "Set variable x to value y"

Note: this only concerns code comments, docstrings are still a good idea, as long as they are maintained

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

Docstring are user documentation, not comments. User documentation, with examples (tests), is always useful.

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

As long as it's maintained. Wrong documentation can often be worse than no documentation.