Software defect indicator
Appearance
A Software Defect Indicator is a pattern which can be found in source code which is strongly correlated with a software defect, an error or omission in the source code of a computer program that may cause it to malfunction.
When inspecting the source code of computer programs, it is not always possible to identify defects directly, but there are often patterns (sometimes called anti-patterns indicating that defects are present.
Some examples of Software Defect Indicators:
- Disabled Code: Code has been written and the programmer has disabled it, or switched it off, without making it clear why it has been disabled, or when or whether it will be reenabled.
- Routine Too Complex: A program (method, module, routine, subroutine, procedure, or any named block of code) contains more than 10 binary terms in conditional statements.
- Unused Variables: There are unreferenced variables in the code. Unreferenced variables are a strong indicator for other errors.
References
- ^ William T. Ward: "Software Defect Prevention Using McCabe's Complexity Metric", Hewlett-Packard Journal, April 1989, pp 64-69: Control-flow complexity has been correlated with low reliabilty and frequent errors.
- ^ David N. Card, Victor E. Church, and William W. Agresti: "An Empirical Study of Software Design Practices", IEEE Transactions on Software Engineering, SE-12, no. 2, February 1986, pp 264-71: 46 percent of routines with no unused variables had no errors compared to only 17 to 29 percent for those with one or more unreferenced variables.
See also
- Cyclomatic Complexity
- Anti-pattern
- Computer program
- Computer programming
- Control flow
- Software engineering