mirror of
https://github.com/github/codeql.git
synced 2026-04-23 15:55:18 +02:00
26 lines
1.1 KiB
XML
26 lines
1.1 KiB
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
<overview>
|
|
<p>This metric measures the number of classes in each file. Files with a large number of classes in
|
|
are more difficult to read and manage. The structure of the project is not reflected in the
|
|
organization of files which can make classes more difficult to find. They can also cause problems
|
|
with version control systems by increasing the likelihood that two developers work on the same file
|
|
at once. That said, there are sometimes advantages to grouping classes together into the same file
|
|
so care should be taken when evaluating this metric.</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
<p>Consider whether the classes are logically related. If they are not then it makes sense to put
|
|
them in separate files. If the main class in the file contains some large nested classes then
|
|
consider moving them to their own files using partial classes.</p>
|
|
|
|
</recommendation>
|
|
<references>
|
|
|
|
<li>MSDN. C# Programming Guide. <a href="http://msdn.microsoft.com/en-us/library/wa80x488%28VS.80%29.aspx">Partial Class Definitions</a>.</li>
|
|
|
|
</references>
|
|
</qhelp>
|