hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-02 12:15:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update Python and C# help for commented-out code to use common qhelp

Browse Source
This commit is contained in:
Felicity Chapman
2019-07-15 09:26:17 +01:00
parent e1454abaf4
commit cb48af7395
6 changed files with 23 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
csharp/ql/src/Bad Practices/Comments/CommentedOutCode.qhelp
View File

@@ -2,23 +2,6 @@
"-//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 should therefore be avoided.
</p>
</overview>
<recommendation>
<p>
Remove the commented-out code, or reinstate it if necessary.
</p>
</recommendation>
<references>
<li>High Integrity C++ Coding Standard: <a href="http://www.codingstandard.com/rule/2-3-2-do-not-comment-out-code/">2.3.2 Do not comment out code</a>.</li>
</references>
<include src="CommentedOutCodeQuery.qhelp" />
<include src="CommentedOutCodeReferences.qhelp" />
</qhelp>

2
csharp/ql/src/Bad Practices/Comments/CommentedOutCode.ql
View File

@@ -1,6 +1,6 @@
/**
* @name Commented-out code
* @description Comments that contain commented-out code should be avoided.
* @description Commented-out code makes the remaining code more difficult to read.
* @kind problem
* @problem.severity recommendation
* @precision medium