ID: py/commented-out-code Kind: problem Severity: recommendation Precision: high Tags: - maintainability - readability - documentation Query suites: - python-security-and-quality.qls
Click to see the query in the CodeQL repository
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.
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.
In the following example, a
def area(r): #if DEBUG: # print("Computing area of %r" % r) return r.length * r.width
Mark Needham: The danger of commenting out code.
Los Techies: Commented Code == Technical Debt.
High Integrity C++ Coding Standard: 2.3.2 Do not comment out code.