forked from github/codeql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFFunctions.qhelp
More file actions
26 lines (20 loc) · 882 Bytes
/
FFunctions.qhelp
File metadata and controls
26 lines (20 loc) · 882 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<!DOCTYPE qhelp PUBLIC
"-//Semmle//qhelp//EN"
"qhelp.dtd">
<qhelp>
<overview>
<p>This metric measures the number of functions in each file.</p>
<p>Tracking this metric over time will indicate which parts of the system are under active development.
Cross-referencing with the other metrics "Cyclomatic Complexity" and "Lines of Code" is recommended,
because files with high values for all three metrics are very likely to be too big and unwieldy; such
files should be split up.</p>
</overview>
<recommendation>
<p>If a file is too big, identify the different tasks that are carried out by its functions and split
the file according to these tasks.</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>