Files
codeql/cpp/ql/src/Metrics/Classes/CSpecialisation.qhelp
2018-08-02 17:53:23 +01:00

49 lines
1.5 KiB
XML

<!DOCTYPE qhelp PUBLIC
"-//Semmle//qhelp//EN"
"qhelp.dtd">
<qhelp>
<overview>
<p>
This metric measures the extent to which a subclass overrides (replaces) the
behavior of its ancestor classes. It is computed as follows: we determine
the number of overridden functions in the subclass (not counting overrides of
abstract functions), multiply by its depth in the inheritance hierarchy and then
divide by its total number of functions.
</p>
<p>
If a class overrides many of the functions of its ancestor classes, it is an
indication that the ancestor classes may not model sensible abstractions.
This is particularly true for subclasses that are lower down in the
inheritance hierarchy. In general, subclasses should add behavior to their
superclasses, rather than redefining the behavior that is already there.
</p>
</overview>
<recommendation>
<p>
The main reason that classes have a high specialization index is that
multiple subclasses specialize a common base class in exactly the same
way. In this case, the relevant function(s) should be pulled up into the base
class (see the 'Pull Up Method' refactoring in [Fowler]).
</p>
</recommendation>
<references>
<li>
M. Fowler. <em>Refactoring</em> pp. 260-3. Addison-Wesley, 1999.
</li>
<li>
M. Lorenz and J. Kidd. <em>Object-oriented Software Metrics</em>. Prentice Hall, 1994.
</li>
<li>
O. de Moor et al. <em>Keynote Address: .QL for Source Code Analysis</em>. Proceedings of the 7th IEEE International Working Conference on Source Code Analysis and Manipulation, 2007.
</li>
</references>
</qhelp>