JAVA编程规范

前一阵子在复习JAVA，搜到了基本的编码规范，感觉很有实用，在此mark一下~
注：文章内容选自软酷实验室~~

---

JAVA编码规范大致可以分为7个部分：

命名规范

• 1、所有的标示符都只能用 ASCII 字母(A-Z 或 a-z)、数字(0-9)和下划线“_”。
• 2、类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。例如:Neeke。
• 3、方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如:setNeekeName(String neekeName)。
• 4、变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。例如:neekeName、neekeAddress。避免单个字符的变量名，除非是一次性的临时变量。不能出现类似 a 等名称的变量。
• 5、常量的声明应该全部大写，每个单词之间用“_”连接。例如:final String WWW_INEEKE_CN = “www.ineeke.com”;

注释规范

• 1、注释尽可能使用“//”;对于所有的 javadoc 的注释则使用“/* /”;而临时对代码块 进行注释尽量使用“/* */”。
• 2、所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。
• 3、每个方法必须添加文档注释(类的 main()方法除外)。每个方法都要有注释. 注释内容为
• 4、参数说明，如果一个类里面的方法是由多个人完成的，每个方法注明是谁所写。
• 5、每个属性必须添加注释。
• 6、注释使用中文（视情况而定）。

缩进排版规范

• 使用 Eclipse 的源代码的格式化功能完成代码的缩进排版 – 快捷键:Ctrl+F。

文件名规范

• 1、一个 Java 源文件只能存储一个 Java 类。
• 2、文件名与 Java 类名相同。

声明规范

• 1、一行声明一个变量。
• 2、不要将不同类型变量的声明放在同一行。
• 3、只在代码块的开始处声明变量。
• 4、所有的变量必须在声明时初始化。
• 5、避免声明的局部变量覆盖上一级声明的变量。
• 6、方法与方法之间以空行分隔。

语句规范

• 1、每行至少包 一条简单语句。
• 2、在 return 语句中，返回值不使用小括号“()”括起来。
• 3、if语句总是用“{”和“}”括起来。
• 4、在 for 语句的初始化或更新子句中，避免因使用三个以上变量，而导致复杂度提高。
• 5、当 switch 的一个 case 顺着往下执行时(因为没有 break 语句)，通常应在 break 语句的位置添加注释。
• 6、while if for 等循环嵌套语句不能超过三层。

编程规范

• 1、提供对实例以及类变量的 public 或 private 访问控制，尽可能不适用默认值或 protected 访问控制。
• 2、避免用一个对象访问一个类的静态变量或方法。应该用类名代替。
• 3、避免在一个语句中给多个变量赋相同的值。
• 4、用于设置对象状态的方法前缀必须是 set;用于检索一个布尔类型对象状态的方法前缀必须是 is，而用于检索其他方法前缀必须是 get。
• 5、程序中应尽可能少使用数字(或字符)，尽可能定义静态变量来说明该数字(或字符)的含义。程序中需要赋值或比较时，使用前面定义的静态变量。在循环控制中例外。
• 6、所有的异常都向上抛。