Files
codeql/cpp/ql/src/Metrics/Files/FunctionLength.qhelp
2018-08-10 08:40:22 +01:00

30 lines
782 B
XML

<!DOCTYPE qhelp PUBLIC
"-//Semmle//qhelp//EN"
"qhelp.dtd">
<qhelp>
<overview>
<p>This metric measures the average number of lines of code per function in a file.</p>
<p>Having too many lines of code in a function is an indication that it can be split into several functions of more manageable size.</p>
</overview>
<recommendation>
<p>Long functions should be examined to see if they can be split into smaller, more cohesive functions.</p>
</recommendation>
<references>
<li>
M. Fowler. <em>Refactoring</em>. Addison-Wesley, 1999.
</li>
<li>
<a href="https://en.wikipedia.org/wiki/Code_refactoring">Wikipedia: Code refactoring</a>
</li>
<li>
<a href="http://www.jot.fm/issues/issue_2005_01/column1/">Refactoring as Meta Programming?</a>
</li>
</references>
</qhelp>