Java编程规范

一、Java关键字

package包

import导入

private私有

protected 保护

public公共

static静态

void声明当前成员方法没有返回值

class类

interface 接口

enum枚举

extends继承

implements 实现

new新建

abstract 抽象

super父类

this当前

boolean布尔型

byte字节型

char字符型

short短整型

int整型

long长整型

float单精度浮点型

double双精度浮点型

final最终

if 如果

else 否则

switch 分支语句结构的引导词

case 用在switch语句之中，表示其中的一个分支

break 跳出循环

continue 从头再来

return 结束当前方法的执行并退出

default默认

while 当

do运行

for为了

try 尝试一个可能抛出异常的程序块

catch捕捉异常

assert断言

finally用于处理异常情况，用来声明一个基本肯定会被执行到的语句块

throw抛出一个异常

throws声明在当前定义的成员方法中所有需要抛出的异常

instanceof 实例

synchronized 同步的

transient 声明不用序列化的成员域

volatile 表明两个或者多个变量必须同步地发生变化

native本地

strictfp 声明单精度或双精度浮点数表达式遵循IEEE754算术规范

二、Java保留字

true 真

false 假

null 空

goto 转到

const 不变的

cast 抛出

future 将来

generic 属性的

inner 内部的

operator 运算符

outer 外部的

rest 休息，剩余的

var 变量

byValue 用…的值

三、Java命名规范

1.使用字母、数字、_、$

2.数字不能放在开头

3.不能是关键字和保留字

4.区分字母大小写

5.没有长度限制

包名必须全部小写，com.baidu.music

类名首字母必须大写

接口首字母必须大写

常量全部大写，单词之间用_连接

变量首字母小写，第二个单词起首字母大写

四、Java编码规范

1.每条语句单独占据一行，用英文;结束

2.每个变量单独占据一行

3.局部变量在声明的同时进行初始化

4.多个连续空格被视为一个

5.格式化代码

6.代码简洁易懂

7.注释详细明确

五、Java注释规范

（一）形式统一，内容简明

1、注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。

2、注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性。

（二）基本注释（必须加）

(a) 类（接口）的注释

(b) 构造函数的注释

(d) 全局变量的注释

(e) 字段/属性的注

备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。

（三）特殊必加注释（必须加）

(a) 典型算法必须有注释。

(b) 在代码不明晰处必须有注释。

(d) 在循环和逻辑分支组成的代码中加注释。

(e) 为他人提供的接口必须加详细注释。

（四）注释格式

1.单行(single-line)注释：“//……”

2.块(block)注释：“/*……*/”

3.文档注释（javadoc）：“/**……*/”

（五）文档注释标签

@author 作者

@version 版本

@note 开发笔记

@remark 客户参考

@see 交叉参考

@param 参数

@return 返回值

@since 最早出现的jdk版本

@exception 可能抛出的异常

@throws 异常类及抛出条件

public @interface MyTag { } 新建注释标签