this post was submitted on 06 Jul 2024
1517 points (99.4% liked)
Programmer Humor
19145 readers
592 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
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Comments should explain "why", the code already explains "what".
Inline comments yes.
Function/Class/Module doc comments should absolutely explain "what".
I agree.
I usually think of that as documentation, not comments.
But even so, the code should say what it does, with a good name. The documentation adds details.