mirror of
https://github.com/github/codeql.git
synced 2026-01-19 09:24:46 +01:00
20 lines
690 B
XML
20 lines
690 B
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
<overview>
|
|
<p>This metric measures the number of comment lines per file. A low number of comments may indicate files that are difficult to understand due to poor documentation.</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
<p>Consider if the file needs more documentation. Most files should have at least a comment explaining their purpose.</p>
|
|
|
|
</recommendation>
|
|
<references>
|
|
|
|
<li>Jeff Atwood. <a href="http://www.codinghorror.com/blog/2005/11/avoiding-undocumentation.html">Avoiding Undocumentation</a>. 2005.</li>
|
|
<li>Steve McConnell. <em>Code Complete</em>. 2nd Edition. Microsoft Press. 2004.</li>
|
|
|
|
</references>
|
|
</qhelp>
|