I just found the following code in our code base:
public String identifyArchitectureName(String platformName, String input) ...
In my opinion input is one of the most meaningless names for a variable that can be. Is it just me? I can just quietly change it, but should I address the fellow programmer that has done it?
Many good questions generate some degree of opinion based on expert experience, but answers to this question will tend to be almost entirely based on opinions, rather than facts, references, or specific expertise. If this question can be reworded to fit the rules in the help center, please edit the question.
It depends on the context to me.
string GetEncrypted(string input)
quite obviously, input is a string to be encrypted. What would you rename this parameter to?
I also use str for methods that perform conversions or string manipulations
MyEnum Parse(string str) // what could str be? login? password? text to be parsed?
public static int? TryToInt(this string str)
I don't think this is the same as
public String identifyArchitectureName(String platformName, String input)
Part of working with others is educating/teaching/mentoring them, in particular if you have seniority.
By all means, take it up with the developer and come up with a better name together.
You are right that the name input doesn't communicate it's intention really well. Uncle Bob talks about "Boy Scout Rule" in his book Clean Code: "Leave the campground cleaner than you found it." The idea is that if you refactor code every time you touch, it is impossible for the code quality to degrade. So feel free to replace the parameter name to more descriptive one.
I wouldn't necessarily confront my coworker for a single instance like that. If that sort of bad naming conventions are typical in you project, then you should gather your team together and come up with common conventions about naming, style etc. Then after everybody knows the rules, they can be enforced with code reviews.
Still, everybody makes mistakes and nitpicking about one parameter name is not cool :) just fix it and get on with whatever you are doing
Do you mean input? Just change it, if you think there is a better name.
It's parameter, renaming it won't break any code.
value which make a lot of sense in their context. input does seem a little on the extreme side of ambiguity.
– MattDavey
Apr 5 '12 at 8:59
I'm in two minds about whether you should confront the other programmer.
My first thought is that I'd be inclined just to rename it and be done with it.
While we should all be big boys about receiving critique, having a conversation about a parameter name on face value seems almost a little petty or over the top.
That being said, if this was just one of a series of "little petty" things I can see it might be the straw that breaks the camel's back.
Do you have a formal peer review process that you could cover this in?
Change it? Sure.
Confront the other person? Not so fast. I'd rather see you kick off a group discussion about coding standards, and add a paragraph to the coding standards document (you have one, right?) that specifies that in non-trivial cases, formal parameters should be self documenting.
