Merge pull request #472 from felicity-semmle/csharp/SD-2778-qhelp-update

C#: Minor updates for consistency (SD-2778)

Author: hvitved

csharp/ql/src/Bad Practices/Naming Conventions/ControlNamePrefixes.qhelp

@@ -8,7 +8,7 @@ This makes the controls easier to find in Intellisense and also makes the purpos
 
 </overview>
 <recommendation>
-<p>Give controls an appropriate prefix to indicate their type (e.g. txt for text boxes or rad for 
+<p>Give controls an appropriate prefix to indicate their type (for example, <code>txt</code> for text boxes or <code>rad</code> for 
 radio buttons).</p>
 
 </recommendation>

csharp/ql/src/Bad Practices/Naming Conventions/ControlNamePrefixes.ql

@@ -1,7 +1,7 @@
 /**
  * @name ASP.NET control name prefixes
- * @description This query checks that certain prefixes are used for naming fields for
- *              ASP.NET Web / HTML controls.
+ * @description Including standard prefixes in the field names of
+ *              ASP.NET Web / HTML controls makes code easier to understand.
  * @kind problem
  * @problem.severity recommendation
  * @precision medium

csharp/ql/src/Bad Practices/Naming Conventions/DefaultControlNames.qhelp

@@ -3,11 +3,12 @@
   "qhelp.dtd">
 <qhelp>
 <overview>
-<p>This rule identifies Windows form controls that have a default name such as <code>textBox1</code>
-.</p>
+<p>This query identifies Windows form controls that have a default name such as <code>textBox1</code>
+. Replacing the default names with names that describe their purpose makes it much easier for other 
+developers to understand your code.</p>
 
 </overview>
 <recommendation>
-<p>Give controls meaningful names that relate to their purpose.</p>
+<p>Give controls meaningful names that indicate their purpose.</p>
 </recommendation>
 </qhelp>

csharp/ql/src/Bad Practices/Naming Conventions/DefaultControlNames.ql

@@ -1,6 +1,7 @@
 /**
  * @name Windows controls with generated names
- * @description Finds fields, corresponding to windows-forms controls, with generated names (such as "label1" or "PictureBox4").
+ * @description Replacing the generated names in windows forms with meaningful names
+                makes it easier for other developers to understand the code.
  * @kind problem
  * @problem.severity recommendation
  * @precision medium

csharp/ql/src/Bad Practices/Naming Conventions/VariableNameTooShort.qhelp

@@ -3,7 +3,7 @@
   "qhelp.dtd">
 <qhelp>
 <overview>
-<p>Source code with lots of short variable names is likely to be hard to read.</p>
+<p>Source code with lots of short variable names is likely to be difficult to read.</p>
 
 </overview>
 <recommendation>

csharp/ql/src/Bad Practices/Naming Conventions/VariableNameTooShort.ql

@@ -1,6 +1,6 @@
 /**
  * @name Variable name is too short
- * @description Variables should have meaningful names so that code is comprehensible. This query finds variable names that are too short.
+ * @description Using meaningful names for variables makes code easier to understand.
  * @kind problem
  * @problem.severity recommendation
  * @precision low