Sunday, June 15, 2025

Naming is straightforward! A information for builders

Sheer laziness

Whereas naming issues isn’t exhausting, it does take a little bit of thought. I suppose some people simply don’t need to take the time to consider naming issues. I’m not even going to speak about how foolish it’s to make use of a single letter for a variable title. The one exception I’ll quarter is utilizing i because the variable in a loop. (However I’ll argue vehemently that Index is best.)

In any other case, give a variable a extremely good, full title. Positive, it might take some effort, however when you cease and ask, “What, precisely, is that this factor?” after which title it based mostly on what your reply is, you’ll have an important title. As an illustration, when you really feel the necessity to do that:


If (EmployeeNumber > 0) and (OrderNumber >  0) {
 // ...
}

Don’t be afraid to go the additional mile:


EmployeeIsValid = EmployeeUniqueIDInDatabase > 0;
ThereIsAnOrder = OrderNumber > 0;
ItIsOkayToProcessTheOrder := EmployeeIsValid and ThereIsAnOrder;
If ItIsOkayToProcessTheOrder {
  // ...
}

That’s massively extra readable, and the variable names clearly clarify what they symbolize. It will be very exhausting to confuse what is going on there, and it reduces the cognitive load of the subsequent developer, who now not has to parse complicated boolean statements. 

Related Articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest Articles