Hard disagree. It's a lot easier and faster to understand a function that is prefaced with a small line of text explaining what it does rather than trying to figure it out yourself.

It's not about whether you can understand the code or not, it's about efficiency and clarity.

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

Yeah, just 15 seconds and jot down a comment. Whenever I’m even hesitant, I just leave a comment. Doesn’t hurt anything and it can always be removed if not needed

Easier to remove later rather than add it after the fact

[–] [email protected] -1 points 4 months ago (1 children)

Hard disagree - that's just dumb:

// Calculates tax
function calculateTax() { }

[–] [email protected] 10 points 4 months ago* (last edited 4 months ago) (2 children)

Hard disagree - that's very helpful:

// Calculates Personal Income Tax by formula from section 1.2.3 of tax code. Other taxes like VAT are not calculated.
function calculateTax() { }

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

This guy gets it.

[–] [email protected] -4 points 4 months ago (2 children)

If it calculates personal income tax, just call calculatePersonalIncomeTax.

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

Why not calculatePersonalIncomeTax123 then?

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

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.

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

Yeah, why not?

[–] plecks 2 points 4 months ago (1 children)

Is that state, federal, or combined?

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

Add a flag.

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

If done right, the "what it does" is in the method name. If your method is too complicated to summarize in its name, chances are good you should split it up or extract parts of it.