this post was submitted on 02 Oct 2023
1544 points (98.4% liked)

Programmer Humor

32558 readers
511 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

founded 5 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 14 points 1 year ago* (last edited 1 year ago) (1 children)

Yeah "why" comments are absolutely fine, "what" comments are useless at best and can be harmful at worst.

I feel like this constant flood of "write comments" posts are from CS students who are told to comment everything by their lecturers. Descriptive variable and function names help explain the "what" of code pretty well most of the time.

Sure with some old languages like C89 where you are limited in your variable name length you probably do need comments to explain wtf is going on, but most code bases aren't as constrained.

[–] [email protected] 10 points 1 year ago* (last edited 1 year ago) (1 children)

I have this argument with other devs all the time.

Hey, you know this 200 line nested if statement that suddenly returns in the middle of the condition is "7"? Yeah, that needs a refactor or at least a fucking comment.

I get a pull request that adds a log line that reads something like "special case 7 triggered.".

[–] [email protected] 2 points 1 year ago

Plot twist: it was a 7 Boom game.