mirror of
https://github.com/github/codeql.git
synced 2026-07-29 06:46:46 +02:00
e21cbe82a9
Where possible update Java documentation links to Java 11. Additionally update some other links to use HTTPS.
42 lines
1022 B
XML
42 lines
1022 B
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
|
|
|
|
<overview>
|
|
<p>A variable name that begins with an uppercase letter does not follow standard
|
|
naming conventions, which decreases code readability. For example, <code>Numberofguests</code>.
|
|
This applies to local variables, parameters, and non-constant fields.
|
|
</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
|
|
<p>
|
|
Begin the variable name with a lowercase letter and use camel case: capitalize the first letter of each word within
|
|
the variable name. For example, <code>numberOfGuests</code>.
|
|
</p>
|
|
|
|
</recommendation>
|
|
<references>
|
|
|
|
|
|
<li>
|
|
J. Bloch, <em>Effective Java (second edition)</em>,
|
|
Item 56.
|
|
Addison-Wesley, 2008.
|
|
</li>
|
|
<li>
|
|
Java Language Specification:
|
|
<a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-6.html#jls-6.1">6.1. Declarations</a>.
|
|
</li>
|
|
<li>
|
|
Java SE Documentation:
|
|
<a href="https://www.oracle.com/java/technologies/javase/codeconventions-namingconventions.html">9 - Naming Conventions</a>.
|
|
</li>
|
|
|
|
|
|
</references>
|
|
</qhelp>
|