JAVA代码开发规范
开发工具规范
三代开发IDE使用Eclipse3.5,编码方式都使用UTF-8,jdk使用jdk1.6。
排版规范
关键词(或变量)和操作符之间加一个空格。
例如:int count = 1;//操作符和值之间有一个空格。
if、for、do、while、switch、方法名、类名后面跟“(”或“{”时,之间要有一个空格。
相对独立的代码块与块之间加空行。
例如:两个方法之间需要用空行隔开。
较长的语句、表达式等要分成多行书写。
长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
代码的新行与上一行根据逻辑关系要进行适应的缩进(一个table键),使排版整齐,语句易读。
不允许把多个短语句写在一行中,即一行只写一条语句。
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。采用table 键缩进。
用大括号‘{’和‘}’界定一段程序块时,编写程序块时‘{’跟在前一行语句之后,并隔一个空格,‘}’应独占一行。
for循环的三个表达式(初始化表达式,循环变量判定表达式,循环变量修正表达式)之间用空格分隔。for-each中用‘:’两边加上空格。
例如:for (int i=0; i<1000; i++) 或 for (User user : userList)
命名规范
package(包)的命名
package 的名字应该都是由一个小写单词组成。并以com.yeepay开始。
例如:package com.yeepaymon;
类名的命名
接口名、类名、方法名、成员变量名、方法内变量命名尽可能表达该类、方法或变量的含义。组成类名的每个单词的首字母大写。
例如:
public class DatabaseOperator {
}
class 中成员变量的命名
变量的名字必须用一个小写字母开头,后面的单词首字母大写。
例如:userType, accountService。
常量的命名
static final 变量的名字应该都大写,命名尽可能表达出完整含义。
例如:
public static final String DB_CONFIG_FILE_PATH ="xxxx";
方法的命名
方法的名的首字母必须小写,之后每个单词的首字母大写。
例如:setName() , handleEvent()。
方法声明中参数命名
使用有意义的参数命名,如果可能的话,使用和要赋值的成员变量一样的名字。
例如:
public void setCounter(int size) {
this.size = size;
}
数组的命名
数组应该总是用下面的方式来命名: byte[] buffer;而不是: byte buffer[];
接口和实现类的命名
接口的命名尽可能表示出这个接口的职责。因为本命名规范中并没有使用数据类型在前的命名方式(如整型的变量以i开头,字符串变量以s开关),因此,接口的命名不必以I开头,实现类的命名采用“接口名称Impl”的格式。
例如:
应该是UserDao或UserService,而不是:IUserDao或IUserService
实现类为:UserDaoImpl或UserServiceImpl,语义上表示:UserDaoImpl是一个UserDao,UserServiceImpl是一个UserService。
代码注释的规范
接口/类的注释
接口/类的注释必须包含如下信息:
接口/类的标题
接口/类的使用描述
接口/类的作者
接口/类的版本号、日期
例子:
/**
*
Title: 类的主题(开发人员填写)
*
Description: 使用说明/描述(开发人员填写)
*
Copyright: 版权信息(模板生成)
*
Company: 公司名称(模板生成)
* @author 作者姓名(模板生成)
* @version 版本号,日期(建议)
*/
/**
* Filename: ${file_name}
* Projectname: ${project_name}
* Title: this is a sample class
* Description:
* Copyright: Copyright (c)2008
* Company: YeePay
* @author: ${user}
* @version: 1.0
* Create at: ${date} ${time}
*
* Modification History:
* Date Author Version