mirror of
https://github.com/github/codeql.git
synced 2025-12-24 20:56:33 +01:00
26 lines
650 B
XML
26 lines
650 B
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
|
|
<overview>
|
|
<p>
|
|
Commented-out code is distracting and confusing for developers who read the surrounding code,
|
|
and its significance is often unclear. It will not get compiled or tested when the code around
|
|
it changes, so it's likely to break over time. For these reasons, commented-out code should be
|
|
avoided.
|
|
</p>
|
|
|
|
</overview>
|
|
|
|
<recommendation>
|
|
|
|
<p>
|
|
Remove or reinstate the commented-out code. If you want to include a snippet of example code
|
|
in a comment, consider enclosing it in quotes or marking it up as appropriate for the source
|
|
language.
|
|
</p>
|
|
|
|
</recommendation>
|
|
</qhelp>
|