Wednesday, June 5, 2013

Java naming convensions

Standard Java Naming Conventions

The below list outlines the standard Java naming conventions for each identifier type:
Packages: Names should be in lowercase. With small projects that only have a few packages it's okay to just give them simple (but meaningful!) names: 
package pokeranalyzer
package mycalculator 

In software companies and large projects where the packages might be imported into other classes, the names will normally be subdivided. Typically this will start with the company domain before being split into layers or features:

package com.mycompany.utilities
package org.bobscompany.application.userinterface 

Classes: Names should be in CamelCase. Try to use nouns because a class is normally representing something in the real world:
class Customer
class Account  

Interfaces: Names should be in CamelCase. They tend to have a name that describes an operation that a class can do:
 interface Comparable
 interface Enumerable  

Note that some programmers like to distinguish interfaces by beginning the name with an "I":
 
interface IComparable
interface IEnumerable  

Methods: Names should be in mixed case. Use verbs to describe what the method does:
void calculateTax()
string getSurname()  

Variables: Names should be in mixed case. The names should represent what the value of the variable represents:
string firstName
int orderNumber  

Only use very short names when the variables are short lived, such as in for loops

Constants: Names should be in uppercase. 

static final int DEFAULT_WIDTH
static final int MAX_HEIGHT 

No comments:

Post a Comment