编码规范
外观
< Java 编程
导航 语言基础 主题: ) |
Java 代码规范由 Oracle 在编码规范文档中定义。简而言之,这些规范要求用户在定义类、方法或变量时使用驼峰式大小写。类以大写字母开头,应该是名词,例如 CalendarDialogView
。对于方法,名称应该是祈使句形式的动词,例如 getBrakeSystemType
,并且应该以小写字母开头。
熟悉并遵循编码规范非常重要,这样由多个程序员编写的代码看起来会一致。项目可能会重新定义标准代码规范,以更好地满足其需求。例如,可以列出允许的缩写,因为这些缩写可能会让其他设计人员难以理解代码。文档应该始终伴随代码。
编码规范的一个例子是定义常量的方式。在 Java 中,常量应该用大写字母编写,单词之间用下划线 ('_') 分隔。在 Java 编码规范中,常量是类中的 static final
字段。
之所以这样区分是因为 Java 区分了“简单”类型和“复杂”类型。将在接下来的部分详细讨论它们。byte
类型是简单类型的示例。类是复杂类型的示例。复杂类型的一个子集是创建后无法修改的类,比如 String
,它是一个字符的连接。
例如,考虑以下“常量”
public class MotorVehicle {
/** Number of motors */
private static final int MOTORS = 1;
/** Name of a motor */
private static final String MOTOR_NAME = "Mercedes V8";
/** The motor object */
private static final Motor THE_MOTOR = new MercedesMotor();
/**
* Constructor
*/
public MotorVehicle() {
MOTORS = 2; // Gives a syntax error as MOTORS has already been assigned a value.
THE_MOTOR = new ToshibaMotor(); // Gives a syntax error as THE_MOTOR has already been assigned a value.
MOTOR_NAME.toLowercase(); // Does not give a syntax error, because it returns a new String rather than editing the MOTOR_NAME variable.
THE_MOTOR.fillFuel(20.5); // Does not give a syntax error, as it changes a variable in the motor object, not the variable itself.
}
}