规范

和别的语言一样, 为了编写时可以舒服一点, 一样需要一个简单的规范

本文档只介绍几个简单的规范, 如果想要看详细的请看阿里巴巴Java开发手册

变量

不同类型的变量间(例如示例变量, 局部变量和静态变量等)有一些命名规范和约定

遵循一些基本规则, 这有助于提高代码的可读性和维护性

以下是各种变量命名规则的概述:

使用有意义的名字: 变量名应该具有清晰的含义, 能够准确的反映变量的用途. 避免使用单个字符和无意义的缩写
小驼峰命名法: 在变量名中使用小驼峰命名法, 即每个单词的首字母大写(除了第一个单词外), 例如: myVariableName
大驼峰命名法: 和小驼峰的区别不大, 唯一的区别就是第一个单词的首字母也是大写, 例如: MyVariableName, 这个命名法基本不用, 主要看个人或团队需求
避免关键字: 不要使用Java的关键字(例如class int boolean等关键字)作为变量名
区分大小写: Java是大小写敏感的, 因此变量中的大小写字母将会被视为不同的符号, 例如MyVariableName和myVariableName是两个不同的变量
不以数字开头: 变量名可以包含数字, 但是不能以数字作为变量名开头
遵循命名约定: 对于不同类型的变量(局部变量, 实例变量和静态变量等), 可以采用不同的命名约定, 例如使用前缀或后缀来区分

和上面的变量需求大差不差, 但也有几个不一样的

Java的规范和JavaScript有些许不一样, Java的常量需要全大写(理论上其实JavaScript也需要, 但是太难看了所以一般没人会写全大写), 其中为了确保可读性, 可以使用下划线_进行单词间的分割

举个简单的例子

java

String SAND_STONE = "sand_stone";

java

int myVariableName = 114514;

java

private int myVariableName = 1919810;

java

// 使用驼峰命名法
public static int myVariableName = 520;

// 使用大写蛇形命名法
public static final int MAX_SIZE = 1314;

java

public static final int PI = 521;

java

public void myMethod(int myParameter) {
	// 方法体
}

java

public class HelloWorld {
	// 类的成员和方法
}