You are viewing a single thread.
View all comments View context
-4 points

If it calculates personal income tax, just call calculatePersonalIncomeTax.

permalink
report
parent
reply
2 points

Why not calculatePersonalIncomeTax123 then?

permalink
report
parent
reply
3 points

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.

permalink
report
parent
reply
1 point

Yeah, why not?

permalink
report
parent
reply
2 points

Is that state, federal, or combined?

permalink
report
parent
reply
0 points

Add a flag.

permalink
report
parent
reply

Programmer Humor

!programmer_humor@programming.dev

Create post

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

Community stats

  • 2.7K

    Monthly active users

  • 866

    Posts

  • 14K

    Comments