下面是java
编程语言的一些命名约定。为了获得良好的维护和代码的可读性,在用java开发软件时必须遵循这些原则。Java使用驼峰式命名法则来对程序中的方法、变量、类、包和常量等进行命名。
类和接口
- 类和接口的名称应该是名词,在含有多个单词的情况下,每个内部单词的第一个字母大写。
- 使用完整的单词,必须避免缩写。
Examples:
Interface Bicycle
Class MountainBike implements Bicycle
Interface Sport
Class Football implements Sport
方法
- 方法的名称应该是动词,在含有多个单词的情况下时,第一个单词的首字母小写,其余单词的首字母大写。
Examples:
void changeGear(int newValue);
void applyBrakes(int decrement);
变量
- 变量的名称应该尽量简短,且有意义;
- 不要以下划线
_
和美元符号$
作为变量的开头; - 应该添加注释,表明变量是被哪个类和方法使用;
- 除了临时变量外,应该避免使用单字符变量名;
Examples:
// variables for MountainBike class
int speed = 0;
int gear = 1;
int userId = 12056;
常量
- 所有的单词都用大写形式来表示,并且单词间通过下划线
_
来分割;
Examples:
static final int MIN_WIDTH = 4;
// Some Constant variables used in predefined Float class
public static final float POSITIVE_INFINITY = 1.0f / 0.0f;
public static final float NEGATIVE_INFINITY = -1.0f / 0.0f;
public static final float NaN = 0.0f / 0.0f;
包
- 惟一包名的前缀总是用全小写ASCII字母编写,应该是顶级域名之一,如com、edu、gov、mil、net、org。
- 包名称的后续组件根据组织自身的内部命名约定而变化。
Examples:
com.sun.eng
com.apple.quicktime.v2
// java.lang packet in JDK
java.lang