Cleaner CDK Code #8: the Java Naming Conventions and Camel Casing

Another simple approach to make your code more readable, is to adhere to the Java naming conventions. They prescribe that variables start with a lower case characters, as do method
names. Class and interfaces, however, start with upper case characters. By all using these same conventions, we need to learn only one scheme and can more easily recognize what are variables, methods and classes. Have a look at these naming conventions by Oracle and the concept of Camel Casing, heavily used in Java.

BTW, note that the CDK conventions deviate from the Oracle conventions just linked to with respect to variable names. We have not found a way to have PMD to differentiate to where variables are used, and therefore require at least three characters per variable name, to enforce some meaningful naming, which is required by Oracle's conventions too.

Previous topics

• Cleaner CDK Code #7: understand what the code is supposed to do
• Cleaner CDK Code #6: set the CDKException's cause Exception
• Cleaner CDK Code #5: develop against interfaces
• Cleaner CDK Code #4: inheriting JavaDoc from super classes and interfaces
• Cleaner CDK Code #3: run the PMD tests
• Cleaner CDK Code #2: String.contains() and logger messages
• Cleaner CDK Code #1: List and the for-each loop