mirror of
https://github.com/github/codeql.git
synced 2026-04-28 10:15:14 +02:00
Initial commit of Python queries and QL libraries.
This commit is contained in:
committed by
Mark Shannon
parent
90c75cd362
commit
5f58824d1b
23
python/ql/src/Metrics/CLinesOfCode.qhelp
Normal file
23
python/ql/src/Metrics/CLinesOfCode.qhelp
Normal file
@@ -0,0 +1,23 @@
|
||||
<!DOCTYPE qhelp PUBLIC
|
||||
"-//Semmle//qhelp//EN"
|
||||
"qhelp.dtd">
|
||||
<qhelp>
|
||||
<overview>
|
||||
<p>This metric measures the number of lines of code in a function. This excludes comments and blank lines.</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>Wikipedia: <a href="https://en.wikipedia.org/wiki/Code_refactoring">Code refactoring</a>.</li>
|
||||
|
||||
|
||||
</references>
|
||||
</qhelp>
|
||||
Reference in New Issue
Block a user