Java基础编码规范

Posted 2021-08-06 laomaocode

Java基础编码规范

1. 语法基础

• 标识符、关键字、保留字
  • 标识符：由程序员指定的变量、方法、类、接口等的别名.。
  • 标识符规范：
    • 区分大小写;
    • 首字母可以是下划线、字母、美元。但不能是数字;
    • 出首字符以外的其它字符，可以是下划线、字母、美元和数字;
    • 关键字不能作为标识符.
  • 关键字：语言已经定义好的类似于标识符的保留字符序列，不能挪作他用，关键字一律小写表示。
  • 保留字：在语言中既不能当作标识符使用，也不是关键字，也不能在程序中使用的字符序列，Java语言的保留字只有const，goto，其中const可以使用public static final 来代替。
• Java分隔符：
  • 分号：表示一条语句的结束。
  • 大括号：表示一个语句块，即语句的一个集合，在定义类和方法是，语句块也被用作分隔类体或方法体。
  • 空格：适当的使用空格可以改善代码的可读性。
• 变量：变量所代表的内容是可以修改的。
• 常量：变量的内容是不可以的被修改的，常量一旦被初始化就不能被修改。
• 事实上常量：有三种类型：静态常量，成员常量和局部常量。
• 变量作用域:作用域规定了变量的适用范围，超过了变量作用域，变量内容就会被释放，根据变量作用域的不同可以分为全局变量和局部变量。

2. 编码规范

• 除了包和常量以外，java编码规范均使用驼峰命名法。
• 包名一律全部用小写，作为命名空间，包名必须具有唯一性。
• 方法名、变量名使用小驼峰命名法，如balanceAccount。
• 类和接口名、文件名使用大驼峰命名法，如CatDao。
• 常量，全部使用大写，多个单词构成可以使用下划线间隔开。

3. 注释规范

• 文件注释：即在每一个文件的开头进行注释，文件注释通常包括版权信息、文件信息、历史版本信息和文件内容等等。
• 文档注释：文档注释就是可以生成API帮助文档的注释，文档注释主要针对类（或者接口）、实例变量、静态变量、实例方法、静态方法等进行注释，主要提供给不看源码的人做参考用
• 代码注释：给阅读源码的人以参考的代码注释
• 地标注释：在源代码中添加一些表示，以便于IDE工具快速定位代码。

4. 空行规范

• 类声明和接口声明之间保留两个空行
• 两个方法之间保留一个空行
• 方法的第一条语句之前保留一个空行
• 代码注释（尾端注释之外）之前保留一个空行
• 一个方法内地两个代码逻辑段保留一个空行

5. 空格规范

• 赋值符号 ” = “ 前后个一个空行

int a = b;

• 所有的二元运算符都应该使用空格与操作数分开

int num = a + b;

• 一元操作符与操作数之间没有空格

a++;

• 小左括号之后，小右括号之前不应当有空格

int num = (a+b)-c

• 大左括号之前应有一个空格

public class Hello {
    ....
}

• 方法参数列表小左括号之后没有空格，小右括号之后有一个空格

public int hello(int num) {
    return num;
}

• 关键字之后与小左括号之间应该有一个空格

while (a == b){
	....
}

6. 缩进规范

• 在方法、Lambda、控制语句等包含大括号的语句块中，代码块地内容相对与首行缩进一个级别（4个空格）
• 如果是if语句中条件表达式断行，那么新的一行应该相对于上一行缩进两个级别，再往后地断行要与第一次的断行对齐。

if (longName == shortName )
	|| (name1 == name2) && (name3 > name4)
	&& (longName = name1)

7. 断行规范

• 一行代码地长度尽量不要超过80个字符，如果超过就需要断行，可以根据下面地规范操作
  • 在一个逗号后面断开
  • 在一个操作符前面断开，要选择较高级别的运算符
  • 新的一行应该相对于上一行缩进两个级别

8. 其它规范

• 在声明变量和常量时推荐一行一个声明
• 每行最多一条语句
• Java语言不建议if和for语句缺省大括号

Love and Share