Java程序命名规范

命名规则：

       尽量避免使用缩写从而产生误解，但是也不要让变量名过长

 

包名：

      包名全部用小写字母

 

类名与接口名：

      类名和接口名称以大写字母开头，往往是名词（逻辑上，非语法上），表明类或接口的职责。类名册和接口名称还采用驼峰式命名原则，名称上的每一个单词的第一个字母大写，其余的小写。

      定制类的时候最好按照类的指责的不同来分类，这样无论是命名还是修改都比较容易。

 

方法的命名：

      方法的命名应该是以一个全部是小写的字母的动词开始，然后后面出现的单词遵循驼峰命名方式。

 

变量的命名：

     常量的命名因该是以小写字母开头的，应该尽量简短，一个变量名的单词与单词之间用驼峰法连接。

 

常量命名：

    常量命名因该全部采用大写字母，单词与单词之间应该以下划线分割。

 

文件布局：

     1、文件注释

     2、文件包或者引用包

     3、具体的类或者接口

 

文件还需要符合一下的格式：

      文件注释部分和包/引用部分需要用两个空行隔开

      声明包或引用包和类或接口定义之间需要用两行空格行隔开

      包声明或引用包之间需要用一行空行隔开

      在类定义中，两个不同的成员方法之间需要用一行空行隔开

 

尽量不要使用IDE提供的包自动Import功能

 

类和声明部分：

      类和声明部分按照下列循序排序：

           类/接口JavaDoc

           类/接口声明  

           类/接口名 

           类/接口成员

           类/接口成员变量 

           类/接口构造方法

           类/接口方法

 

源码格式：

         Java规定的Tab是8个空格，而不是4个。

         一行超过80个字符的时候，需要跳行，跳行在都好或者操作符之后进行，新起的一行需要用Tab起头。

        if和While，for等循环的跳行缩进是空4格。不要和别的缩进混淆。

        如果一个方法调用的时候需要用一个函数的返回值作为参数，那么该函数在方法的声明中最好单独一行。

        如果函数的参数是一个需要计算的表达式，那么表达式最好也单独占一行。

        

       对于直接用函数调用座参数或者表达式做参数的情况，最好用重构（refactor）的方法将其抽取出来赋值给一个变量，这样代码的可读性会更高。

   

       如果缩进的层级达到三级或者四级的时候，就很难遵循上述的缩进格式，这时考虑用重构的方法减少缩进的层次。

 

空格:

        关键字和括号之间需要空格   

        逗号之后需要空格

        表达式之间需要空格

        类型转换之间需要空格

        二元操作数之间需要空格

 

声明格式：

        规定在控制语句（if）等中，必须使用大括号来包围声明语句，哪怕声明只有一句也必须用大括号括起来

        声明语句的缩进是四个空格。

 

注释：

        Java的注释有两种格式：JavaDoc格式和一般格式

        javadoc是让程序的使用者明白程序的大意 的注释格式。

        一般注释格式：

        1、单行注释         //文字注释

        2、多行注释         /*注释文字，中间可以换行*/

        因该尽量避免使用多行注释，而多使用单行注释，单行注释和所需的代码处在同一行，并且以8空格字符隔开。

 

泛型：

        尖括号内部的类型和尖括号之间没有空格

        尖括号和容器名称之间没有空格

        尖括号和后面的圆括号之间没有空格

        List<Dog> dogList   =  new  ArrayList<Dog>();

 

高级循环：

        高级循环需要注意的格式就是在冒号的前面和后面都是有空格的

 

关于静态Import

        虽然静态Import能够从别的包中直接调用引入类的静态方法个变量，但是不推荐直接使用静态引入的变量，还是建议在需要使用的时候在包里自己定义，这样比较清楚，不容易引起混乱。