aspose file tools*
The moose likes Beginning Java and the fly likes Bad Form to name indentifier and method the same? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Bad Form to name indentifier and method the same?" Watch "Bad Form to name indentifier and method the same?" New topic
Author

Bad Form to name indentifier and method the same?

Adam Price
Ranch Hand

Joined: Nov 11, 2005
Posts: 95
Is it considered poor form to do something like this:


shoeSize is the method, shoeSize is the variable that is returned within the method.

I know there are other ways to do this particular example - and I am using one of them in the code that made me think of this, but in general, does one avoid having a method named similarly to one of it's internal variables?
Bear Bibeault
Author and ninkuma
Marshal

Joined: Jan 10, 2002
Posts: 60990
    
  65

A more conventional approach is to name methods that return a property such as "shoeSize" as getShoeSize().


[Asking smart questions] [Bear's FrontMan] [About Bear] [Books by Bear]
Jim Yingst
Wanderer
Sheriff

Joined: Jan 30, 2000
Posts: 18671
However, this convention isn't an absolute requirement, and there are many classes in the standard libraries that don't follow it - size() being one very common example. I think it's only a problem if you're using some reflection-based framework that assumes getters and setters will always follow the standard naming convention. In many classes this will not be an issue. In my experience there's no real problem if a method name matches a field name - it's always possible to tell which one you're talking about, based on whether or not there's a () after. (And in many cases they would have the same effect anyway.)

What I think would be a bad idea, would be if a method and field had the same name but were actually unrelated. If I see a field named size, and a method named size(), I'm probably going to expect that the definition of size() is

If on the other hand, it's

then I think that's a potential source of confusion; I wouldn't recommend that.


"I'm not back." - Bill Harding, Twister
Stan James
(instanceof Sidekick)
Ranch Hand

Joined: Jan 29, 2003
Posts: 8791
I actually named a getter the same as a member variable the other day. I was aware it was counter to convention but it felt good.

C# (and I think Delphi Pascal) allow clients to reference variables as "object.var" and the object developer can add or remove getters and setters without affecting the clients. Slick.


A good question is never answered. It is not a bolt to be tightened into place but a seed to be planted and to bear more seed toward the hope of greening the landscape of the idea. John Ciardi
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Bad Form to name indentifier and method the same?