Programming conventions in java

Question

I have a simple question about one aspect about so called programming conventions in java.

Simply - if I pass a local variable in one method to a another (helper) method - should I keep the name of it to 100 percent or try to rename it slightly?

Look at the example - should I rename the variable totalAmount in the helpermethods signature to something similar (for instance total_amount or theTotalAmount)?

private void myMethod() {

   int totalAmount = 0;
   // calculations where totalAmount is involved.

   myHelperMethod(totalAmount); // send totalAmount to a another method.

}

private void myHelperMethod(int totalAmount) {

    // use totalAmount here .....
}

That is your choice; just find a name that best suits what the method does/what you prefer. There is no real convention here other than naming conventions. — fge
– fge, Commented Jul 12, 2013 at 9:56

xlecoustillier · Accepted Answer · 2013-07-12 11:59:43Z

11

There's absolutely no obligation to keep the same variable name.

Just choose a name that fits the local context.

In your example, your myHelperMethod could potentially receive any amount as a parameter, not necessarily a totalAmount. Let's just name it amount, or anything else that describes its actual role in this method.

edited Jul 12, 2013 at 11:59

answered Jul 12, 2013 at 9:56

xlecoustillier

16.4k15 gold badges64 silver badges88 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

nette · Accepted Answer · 2013-07-12 09:58:15Z

2

No, you need not. Its like pouring water from one glass to another, the value(water) will remain the same, the glass(holder) will change.

answered Jul 12, 2013 at 9:58

nette

5752 gold badges9 silver badges25 bronze badges

Comments

Sergey Kalinichenko · Accepted Answer · 2013-07-12 10:02:25Z

2

Even in cases when the call is a variable-for-variable (it could be expression-for-variable) the two names represent conceptually different things, so you should not be naming them the same unless they really mean the same thing.

Formal parameters represent variables with names meaningful inside the function, while variables that you pass represent variables with names meaningful outside the function. Here is an example:

// Function definition
static double computeDiscount(double originalPrice, double discountPercentage, double cap) {
    ...
}

// Function calls
double priceClothing = computeDiscount(clothingOrigPrice, discountPercentage, clothingDiscountCap);
double priceAccessories = computeDiscount(accessoriesOrigPrice, discountPercentage, accessoriesDiscountCap);

edited Jul 12, 2013 at 10:02

answered Jul 12, 2013 at 9:57

Sergey Kalinichenko

729k85 gold badges1.2k silver badges1.6k bronze badges

Comments

Juned Ahsan · Accepted Answer · 2013-07-12 09:58:09Z

0

It's your choice to decide about the names. Conventions don't tell what name you should keep. Use names which reflects the entity the best. And also avoid using the confusing names. In your case if both the 'totalAmount' are actually representing the totalAmount, then you made the right choice. If not, then reconsider changing the names.

answered Jul 12, 2013 at 9:58

Juned Ahsan

68.9k12 gold badges101 silver badges138 bronze badges

Collectives™ on Stack Overflow

Programming conventions in java

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related