this post was submitted on 06 Jul 2024
1547 points (99.4% liked)

Programmer Humor

19488 readers
1062 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
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 74 points 4 months ago (12 children)

Comments should explain "why", the code already explains "what".

[–] [email protected] 28 points 4 months ago (3 children)

Inline comments yes.

Function/Class/Module doc comments should absolutely explain "what".

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

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.

load more comments (2 replies)
load more comments (10 replies)