Another term for common code smell [closed]

Question

Is there a need to differentiate using smells to find underlying problems and a term for common code smells. It's more about prevention like returning the milk to the refrigerator because you have a pretty good idea what is going to happen and just replacing it is not the best solution.

Edit: made a considerable change to the nature of the question, but still dislike the term.

Answer 1

I worked in a large corporation which had absolutely no sense of humor. We used "refactor point" instead of code smell.

Eg

That duplicated code is a potential refactor point.

Update:

Personally I've no problem with the term "Code Smell".

Our problem was a zero tolerance on anything which may have been offensive:
Whiny Intern: He said my code smells! I'm offended and will sue the company!
p.s. this never actually happened, but they disallowed Code Smell anyway.

Refactor point - often following "potential" slid nicely under the radar, we knew what it meant and it didn't set off any - overly sensitive - "offencive" alarms.

p.s. At the same company, in a code review I was told to remove the comment "Nothing to do here, so get out of Dodge", reviewers comment was something along the lines of "You might find that hilarious but there are professional people here who are serious about their work". I - somehow - managed not the strangle the git.

. . . and yes I am aware that comments are a code smell :)

Edit - as suggested by E.Z. Hart (this is too good not to have in the answer)

"Potential Refactor Point" can be shortened to PRP and pronounced "perp".
Then all of your scrums/meetings/code reviews start sounding like a cop drama.

• "We identified several potential perps"
• "We're on the trail of the perp"
• "We nailed the perp"
• etc. :)

Answer 2

My submission:

Refactor Bait

(and if you say it really fast, it sounds kinda dirty)

Answer 3

Why use a negative label? Just say

I think the readability/maintainability/whatever could be improved here

And always be ready

1. To explain how to improve it
2. To explain why it's better your way.
3. To hear why, just this once, you might be wrong!

EDIT because the question has changed!

Code smell is too emotionally charged. The author of the code likely has a strong sense of ownership and it can be hard to hear criticism. If you start right out by saying it smells, the subsequent discussion may generate more heat than light. Instead be positive and talk about potential improvements.

Answer 4

TechnicalDebt

We call it TechnicalDebt.

Answer 5

Code Omen

From Wikipedia

In computer programming, code smell is any symptom in the source code of a program that possibly indicates a deeper problem.

Keeping true to this definition Code Omen sounds appropriate IMHO

Edit:

Id like to add Why code smell in the first place? Because its catchy and simple in an annoying kind of way.

Smell is a symptom which indicates a future problem. a refined alternative to smell would be Omen which is also basically an indicator of a future problem. There wouldnt be a positive aspect to omen in this context as the positive aspect would mean every thing is fine and there is no point to be considered.

Potential refactor point would be good in comments. But is it as catchy ( say refactor bait) in speaking terms.

Answer 6

Great question, I also loathe the term 'code smell' as ridiculous hyperbole.

I suggest

Code Stain

at least it's a valid visual metaphor.

Answer 7

"Broken window" would be another term that comes to mind that hasn't been said yet.

Answer 8

I think the term "code smell" is going to be difficult to get rid of. It is an effective term because it is so evocative. You smell something bad, you start investigating and you find the source of the smell (an Anti-Pattern?) that might be a "potential refactor point" (thanks @Binary Worrier).

The only alternative I can think of at the moment is code smoke.

Answer 9

Two terms come to mind (I'm not a native English speaker though)

• Quick & dirty solution

• kludge

Answer 10

At first I thought this was a great question. I still think it would be great if it was generating responses that could be synonyms.

However, after reading the highest voted answer, "potential refactor point", I feel like I have to say that is not a synonym, and neither are most of the other suggestions!

"Code smell" is good because it describes exactly what the problem is - the code may not be bad itself, it may not be anything on its own , but it is something has been known to indicate that there is a problem lurking somewhere.

The "smell" analogy is so good because if you start "sniffing" at the location of the smell, a good investigator can be led right to the problem!

One case which illustrated this to me well recently was the question Code Smell: Inheritance Abuse. After reading the question and answers, I started to notice inheritance trees in our own code that smelled. They weren't necessarily "potential refactor points" because they were only the surface where problem symptoms became obvious. The real refactor points are deeper underneath, but the investigation started at the inheritance tree.

When you fix the real problem, the smell goes away, just like a bad cabin air filter in a car, or mold within walls.

Just keep using code smell, but use it correctly and lets all try not to overuse it!

Answer 11

Maybe Anti-Pattern, even if I'm not sure it does match exactly the same idea. It's more than anti-patterns, it's more like "anti-structure".

Answer 12

Code rot doesn't necessarily mean the same thing, but could be used in a similar context.

Answer 13

How about bad code? 99% of the time it's personal taste taken out of context.

Answer 14

Code Combustion: Trogdar, Burninator!

I think as it stands, the 'code smell' metaphor is apt. There is a certain subjectivity within each encounter. Some are distinct, and a consensus is easier to acomplish. Some might be considered subtle depending on the sensativity of the observer.

Answer 15

Normally when you have a lot of code smells, you might actually have a big ball of mud. So you can call it mud.

Answer 16

Principle Violation

I determine whether code is acceptable based on whether it violates SOLID principles, whether it engages in known anti-patterns, whether it violates a defined coding standard, etc.

So, if code (and its programmer) dare to violate principles surrounding these concept, then they've committed a principle violation.

Another thought: Code Sin

Answer 17

Skunk

Because it stinks, code smell is not that precise, as it can also mean a "pleasant" smell.

Answer 18

A manifestation of inelegance

"Code smell" rolls off the tongue a little easier though.

Answer 19

How about SNR<1.

Answer 20

If they are truly common, then maybe non-standard.