A Code smell is an interesting Software Engineering concept. According to Wikipedia, a Code Smell
“refers to any symptom in the source code of a program that possibly indicates a deeper problem. According to Martin Fowler, “a code smell is a surface indication that usually corresponds to a deeper problem in the system“. Another way to look at smells is with respect to principles and quality: “smells are certain structures in the code that indicate violation of fundamental design principles and negatively impact design quality“.
Common code smells include:
- Class-level smells
- Large class, Feature envy, Inappropriate intimacy, Refused bequest, Lazy class/freeloader
- Method-level smells
Code Smells detection tools
Some free code smell detection tools (which perform static code analysis) include:
- PMD (Java)
- JDeodorant (Java)
- FxCop (C# / .NET)
- StyleCop (C# / .NET)
- NOTE: StyleCop works with source code, whereas FxCop works with compiled files
Most of these smells lower your code’s quality and maintainability. Be sure to include some of these detection tools on your development processes, as well as appropriate coding standards. Automatic noncompliance detection can be accomplished by adding these tools to your build process.
You can research more tools at https://en.wikipedia.org/wiki/List_of_tools_for_static_code_analysis
- Tufano, M.; Palomba, F.; Bavota, G.; Oliveto, R.; Di Penta, M.; De Lucia, A.; Poshyvanyk, D. (2015-05-01). “When and Why Your Code Starts to Smell Bad” (PDF). 2015 IEEE/ACM 37th IEEE International Conference on Software Engineering (ICSE). 1: 403–414. doi:10.1109/ICSE.2015.59.
- Fowler, Martin. “CodeSmell”. martinfowler.com/.
- Suryanarayana, Girish (November 2014). Refactoring for Software Design Smells. Morgan Kaufmann. p. 258. ISBN 978-0128013977.