Use full descriptors that accurately describe the variable, field, or class

For example, use names like firstName, grandTotal, or CorporateCustomer. Although names like x1, y1, or fn are easy to type because they're short, they do not provide any indication of what they represent and result in code that is difficult to understand, maintain, and enhance.

Back to top

Use terminology applicable to the domain

If your users refer to their clients as customers, then use the term Customer for the class, not Client. Many developers make the mistake of creating generic terms for concepts when perfectly good terms already exist in the industry or domain.

Back to top

Use mixed case to make names readable

You should use lowercase letters in general, but capitalize the first letter of class names and interface names, as well as the first letter of any non-initial word.

Back to top

Use abbreviations sparingly and intelligently

This means you should maintain a list of standard short forms (abbreviations), you should choose them wisely, and you should use them consistently. For example, if you want to use a short form for the word number, then choose one of nbr, no, or num, document the one you choose (it doesn't really matter which one), and use only that one.

Back to top

Avoid long names (15 characters max is a good idea)

Although the class name PhysicalOrVirtualProductOrService might seem to be a good class name at the time (OK, I'm stretching it on this example), this name is simply too long and you should consider renaming it to something shorter -- perhaps something like Offering.

Back to top

Avoid names that are too similar or that differ only in case

The variable names persistentObject and persistentObjects should not be used together, nor should anSqlDatabase and anSQLDatabase.

Back to top

Capitalize the first letter of standard acronyms

Names will often contain standard abbreviations, such as SQL for Standard Query Language. Names such as sqlDatabase for an attribute or SqlDatabase for a class are easier to read than sQLDatabase and SQLDatabase.

Resources

• Building Object Applications That Work: Your Step-By-Step Handbook for Developing Robust Systems with Object Technology by Scott W. Ambler
  
  
• The Object Primer 2nd Edition by Scott W. Ambler
  
  
• The Elements of Java Style by Alan Vermeulen, Scott W. Ambler, Greg Bumgardner, Eldon Metz, Trevor Misfeldt, Jim Shur, and Patrick Thompson
  
  

About the author

Rate this article

Comments

Back to top

Table of contents

• Use full descriptors that accurately describe the variable, field, or class
• Use terminology applicable to the domain
• Use mixed case to make names readable
• Use abbreviations sparingly and intelligently
• Avoid long names (15 characters max is a good idea)
• Avoid names that are too similar or that differ only in case
• Capitalize the first letter of standard acronyms
• Resources
• About the author
• Comments