JAVA编码规范

1. 概述
   1. 编写目的

本文档记述了JAVA开发中的有关包、类、抽象类、接口、方法、变量和常量的命名规则，用于规范JAVA编码过程中的命名和代码书写规范。

 

1. 文件构成
   1. 文件名

1. 一个JAVA文件中只允许有一个public的类。

例：Point.java文件夹中，只能有public class Point类。

1. private类最好能放在主要使用它的public类中。    
   1. 文件位置

包名要跟工程的路径名对应下来。

例：包com.sj.wx.framework，对就的路径为

      <ProjectRoot>/com/sj/wx/framework

1. 1. 测试类名

类ClassName如果有测试类的话，测试类的类名为ClassNameTest，测试类要都放在一个包中。

 

1. 命名规范
   1. 包名

包名应全部是小写字母，包名中不能出现下划线，并且第一个字母不能是数字。

例：cn.com.sj.wx.framework

1. 1. 文件名

文件名一定要与文件中public类的名称一样类名

1. 1. 类名

类名应该是一个名词，采用大小写混和的方式，用英文单词或英文单词的缩写，不能用汉语拼音。

    例：public class Department

1. 1. 异常类名

异常类的类名最后要加上【Exception】。

    例：MemoryException

1. 1. 接口名

如果没有特殊要求，接口名要以【I】开头，后面再加上名称，命名方法与类一样。

    例：IUser

1. 1. 抽象类名

抽象类的开头要加上【Abs】，后面再加上名称，命名方法与类一样。

    例：AbsUser

1. 1. 常量(static final)

常量定义时要全部大写，并以【_】作为连接符，一行中只能定义一个常量。

例：/** 最小宽度 */

final static int MIN_WIDTH = 4;

    

    /** 最大宽度 */

    final static int MAX_WIDTH = 99;

1. 1. 方法名

方法名应是一个动词或动名结构，采用大小写混合的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。

例：getGoodList()

1. 1. 变量名

定义规则，以变量的数据类型开始+变量名，开头字母小写。

数据类型及简写

  byte       byt

  short      shr

  int        int

  long       lng

  float       flt

  double     dbl

  char       chr

  boolean    bol

  String      str

  List        lst

  Map       map

例：要定义一个String型的变量时

    String strGoodName = “”;

注意：变量在定义时一定要加上初始值，一行只能定义一个变量。

1. 1. 属性取得方法

以【get】开始。

例：String getGoodName()

    boolean isEnabled()

    boolean hasParmission()

1. 1.  属性设定方法

以【Set】开始。

    例：void setX(X value)

1. 1.  返回值为boolean的方法

is+形容词、can+动词、has+过去时动词。

boolean isEmpty()   // 正确

boolean empty()    // 错误

 

boolean canGet()

boolean hasChanged()

1. 1.  boolean变量

形容词，is+形容词，can+动词，has+过去时动词

 

1. 代码书写规范

类的方法的代码行数不能过长，尽量控制在300行以内，长的方法要拆分。

1. 1. 返回值

一般情况下，方法的返回值不应返回null。而是尽量使用异常代替返回null。如果在特殊情况下必须返回null，必须在方法中加以特别说明。

1. 1. 异常

整个系统中应使用自行设计的唯一自定义的异常类，该类包括message(错误信息)各messageID。

1. 1. 注释

类中必须有注释，注释的行数不得低于代码行数的20%。

1. 类的注释

在类之前加上注释。

/**

 * 描述XXXXXXXXXXXXX

 *

* @author Administrator.

 */

public class ClassName {

}

1. 方法的注释

在方法的上面加注释，使用Eclipse自带的注释功能。带参数的方法一定要将参数描述清楚。

1. 方法内的注释

方法内的注释用【// 】来定义。

例：

public String getGoodName() {

 

    // 商品ID

    String strGoodID = “”;

}