In computer programming, code smell is any symptom in the source code of a program that possibly indicates a deeper problem. Code smells are usually not bugs—they are not technically incorrect and don't currently prevent the program from functioning. Instead, they indicate weaknesses in design that may be slowing down development or increasing the risk of bugs or failures in the future.
Often the deeper problem hinted by a code smell can be uncovered when the code is subjected to a short feedback cycle where it is refactored in small, controlled steps, and the resulting design is examined to see if there are any further code smells that indicate the need of more refactoring. From the point of view of a programmer charged with performing refactoring, code smells are heuristics to indicate when to refactor, and what specific refactoring techniques to use. Thus, a code smell is a driver for refactoring.
The term appears to have been coined by Kent Beck on WardsWiki in the late 1990s. Usage of the term increased after it was featured in Refactoring: Improving the Design of Existing Code. Code Smell is also a term used by agile programmers.
Determining what is and is not a code smell is often a subjective judgment, and will often vary by language, developer and development methodology. There are tools, such as Checkstyle, PMD and FindBugs for Java, to automatically check for certain kinds of code smells.
Read more about Code Smell: Common Code Smells
Famous quotes containing the words code and/or smell:
“Wise Draco comes, deep in the midnight roll
Of black artillery; he comes, though late;
In code corroborating Calvin’s creed
And cynic tyrannies of honest kings;
He comes, nor parlies; and the Town, redeemed,
Gives thanks devout; nor, being thankful, heeds
The grimy slur on the Republic’s faith implied,
Which holds that Man is naturally good,
And—more—is Nature’s Roman, never to be
scourged.”
—Herman Melville (1819–1891)
“But, when nothing subsists from a distant past, after the death of others, after the destruction of objects, only the senses of smell and taste, weaker but more enduring, more intangible, more persistent, more faithful, continue for a long time, like souls, to remember, to wait, to hope, on the ruins of all the rest, to bring without flinching, on their nearly impalpable droplet, the immense edifice of memory.”
—Marcel Proust (1871–1922)