this post was submitted on 06 Jul 2024
1547 points (99.4% liked)
Programmer Humor
19817 readers
47 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 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Hard disagree - that's very helpful:
This guy gets it.
If it calculates personal income tax, just call
calculatePersonalIncomeTax
.Why not
calculatePersonalIncomeTax123
then?I'm a new developer. Is that referring to page 123 of the in-house documentation? Version 12.3 of the code? I have no clue.
You'd have to call it something like calculatePersonalIncomeTaxPerTaxCodeSection1_2_3, but I get exhausted just looking at that. There comes a point where the cognitive work of reading crazy long camel case names is more trouble than it's worth.
An explanation of what specification a function was written to implement is a perfectly appropriate comment. Could be improved by a direct link where possible. But it's worth noting what that comment isn't doing - specifying any implementation details. For that, I really can just read the code.
Yeah, why not?
Is that state, federal, or combined?
Add a flag.