Java编码规范(草台班子专用简化版）

1.接口文件的注释说明规范（以JavaDoc接口为例）

 

package com.tisson.zrftest;

/**

* JavaDoc测试接口

* @author : zhengrf1

* @date创建时间：2017年2月8日下午3:50:27

* @version 1.0

* @parameter 

* @since 

* @return 

*/

public interfaceJavaDoc {

 

    /**

    *JavaDoc测试方法fun1

    *@author : zhengrf1

    *@date创建时间：2017年2月8日下午4:03:03

    */

    public int fun1(int a);

   

    /**

    *JavaDoc测试方法fun2

    *@author : zhengrf1

    *@date创建时间：2017年2月8日下午4:03:19

    */

    public int fun2(int b);

}

1.开头包名package com.tisson.zrftest;

2.文件说明注释，包括功能作用，创建者，创建时间，版本号等重要信息

3.接口中的声明方法要比接口名缩进一个制表符，方法声明与方法声明间空格一行

4.接口方法的注释说明包含该方法的功能作用，创建者，创建时间信息

 

2. 实现类文件的注释说明规范（以JavaDocImpl接口为例）

package com.tisson.zrftest;

/**

* JavaDoc测试实现类

* @author : zhengrf1

* @date创建时间：2017年2月8日下午4:05:09

* @version 1.0

* @parameter 

* @since 

* @return 

*/

public classJavaDocImpl implements JavaDoc {

 

    /**静态常量_MAXNUMBER*/

    public static final long _MAXNUMBER=100;

    /**静态常量_MINNUMBER*/

    public static final long _MINNUMBER=100;

    /**常量_Max*/

    public final int _Max=20;

   

    /**静态成员STATICVAl1*/

    public static int STATICVAl1=10;

    /**静态成员STATICVAl2*/

    public static int STATICVAl2=10;

   

    /**普通成员变量FileName*/

    public String FileName;

    /**普通成员变量FileType*/

    public String FileType;

   

    /**

    *静态成员方法STATICFUN

    *@author : zhengrf1

    *@date创建时间：2017年2月8日下午5:02:22

    */

    public static void STATICFUN(){

        System.out.println(_MAXNUMBER);

    }

 

    /* @date 创建时间：2017年2月8日下午4:13:55

     * @see com.tisson.zrftest.JavaDoc#fun1(int)

     */

    @Override

    public int fun1(int a) {

        // TODO Auto-generated method stub

        StringstrOutPut="hello";   //局部成员变量strOutPut

        int count=2;                //局部成员变量count

       

        /*循环输出字符串*/

        if(strOutPut != null){

            int tmpValue=0;         //临时局部变量tmpValue

           

            for(int i = 0; i<count; i++){

                System.out.println(strOutPut);

            }

           

        }

       

        return 0;

    }

 

    /* @date 创建时间：2017年2月8日下午4:14:11

     * @see com.tisson.zrftest.JavaDoc#fun2(int)

     */

    @Override

    public int fun2(int b) {

        // TODO Auto-generated method stub

        return 0;

    }

   

    /**

    *测试方法funTest

    *@author : zhengrf1

    *@date创建时间：2017年2月8日下午4:59:38

    */

    public void funTest(){

       

    }

 

    /**

    *

    *@author : zhengrf1

    *@date创建时间：2017年2月8日下午4:05:09

    */

    public static void main(String[] args) {

        // TODO Auto-generated method stub

        JavaDoc  javaDoc=newJavaDocImpl();     //创建实现类对象，引用类型是接口

       

        JavaDocImpl.STATICFUN();                //调用静态成员方法使用类名调用

        javaDoc.fun1(10);                       //调用重写后的方法fun1

    }

 

}

1.      第一行是包名，接口和实现类都一样，实现类名一律在接口名后加上Impl后缀

2.      常量成员变量（带final）一律下划线+大写单词

3.      静态非常量成员变量一律大写单词不加下划线前缀

4.      非静态成员变量一律首单词小写，其他单词首字母大写。

5.      成员变量的声明顺序是常量，静态变量，普通变量，每个成员变量都应该加注释，中间加一空行

6.      每个成员方法之前一律加注释，介绍功能，创建者等信息，重写方法用@see com.tisson.zrftest.JavaDoc#fun2(int)代替功能介绍

7.      静态成员方法名一律大写

8.      非静态成员方法名第一个单词开头字母小写，其他单词开头字母大写

9.      所有的局部变量都应该在作用域最开头进行定义声明,不应该使用时再定义声明,并且应该和作用域中的逻辑代码隔一空行

10.  对局部变量的注释统一用//符号

11.  If，for等逻辑代码的大括号{统一放置在语句词后面，嵌套层次都应用制表符进行缩进，不同的层次语句块之间（无论嵌套还是并列都应该隔一空行）。逻辑块的注释一律在前面一行用/*说明文字*/方式

12.  Return 语句应该跟代码逻辑语句隔一空行

13.  使用类的静态成员方法一律用类名调用而不用对象引用调用

 

总结：目前想到的就这么多，草台班子最简洁实用的java编码规范。