代码规范

 

java代码规范：

1 文件中各成分的出现顺序为：

    1）开始的注释，2）package语句，3）import语句，4）类/接口声明

 

2 在一个Java类中，各种成分的排列顺序本无严格规定，也没有特别通用的惯例，为便于掌握，给出一个推荐的顺序：

    1）属性声明，2）构造方法声明， 3）static语句，4）普通方法声明，5）main方法声明，6）内部类的声明

 

3所有java文件的开头都要至少有作者的注释。

例如：

/**

  *

  * @author xxh

  */

 

4个人、公司和家庭简写的统一：individual-indi，family-fami，corporation-corp。

 

5 包名全部小写。

 

6 类和接口名应该是名词，而且组成它的每个单词的首字母必须大写，单词之间用大写字母隔开(例如：EmployeeHours）。

 

7 方法名应该是动词，不能有下划线“_”。第一个单词的首字母小写，接下来的单词的首字母大写（例如：getHoursWorked）。

 

8 方法明前必须有方法的说明。

    /**

      * Show file list in the current directory .

      */

 

9 变量命名全部用小写，单词之间用“_”隔开（例如：public String business_address）。只有一个字母的变量（例如，i、j、k）应该避免出现，除非是一个暂时变量（例如：在一个for语句中）。

 

10 尽量使类中所有的变量都是私有的，只能通过方法来访问它们。

 

11 常量应该全部大写，单词之间由下划线分隔（例如：MAX_WORK_HOURS）。

 

12 避免一行中超过80个字符。

 

13 一行应该包含一个语句。

 

14 在使用if-else、for、while、do和switch语句时应该使用大括号。

例如：for(int I , ,){

  }