Java开发规范
2008年1月7日
• 1.程序编写规范
• 2.性能
• 3.注意事项
1.1 命名规范
u Package 的命名
Package的名字应该都是由一个小写单词组成
u Class 的命名:
CtBIZC130301GetPersonInfo、EnBizInfo
u Class 变量的命名
变量名采用英文单词的组合; 第一个单词小写,后面的单词首字母大
写;最多不超过三个单词;其单词为代表实际意义的英文单词。
EnBizInfo theBizInfo = new EnBizInfo();
u Static 、Final变量的命名
变量名应该全大写的英文单词和下划线组合,并且指出完整含义
u 数组的命名
Byte[ ] buffer; not byte buffer[ ];
u 方法 的命名
方法名采用英文单词的组合,以动词英文单词开头,第一个单词全小
写,剩下单词首字母大写,最多不超过三个单词,其单词为代表实际
意义的英文单词
getPersonInfo()
u 方法的参数:
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名
字
SetCounter(int size){
this.size = size;
}
u 避免“神秘”数字:
我们在程序里经常会用到一些有特定含义的数字,如果我们直接在代
码中书写数字会降低程序的可读性,应该尽量避免。避免的方法是把
神秘的数定义为一个常量。注意这个常量的命名应该能表达该数的意
义,并且应该全部大写,以与对应于变量的标识符区别开
1.2 Java文件格式
所有命名均不采用拼音的全拼或者简拼,或拼音缩写
Ø 1.2.1 版权信息:
版权信息必须在 java 文件的开头,比如:
/**
* Copyright ® 2004 Powerise.
* All right reserved.
* Description: xxxxxxxxxxxxxxxxx
* Author: xxxx
* Create Date: xxxx/xx/xx
* Modify Info:xxxxxx
*/
说明:Java的注释与其它语言有一个不同点,如果采用“/**”和“*/”格式注
释所包括的内容,可以由Javadoc工具自动生成类的相应文档。因此在撰写
注释时,如果是类的解释和版权信息等相关描述信息时,建议采用“/**”和
“*/”格式
1.2.2 Packeage/Imports
说明:
Package 行要在 import 行之前 , 而且按照字母顺序排列;
如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理;
原则上要求尽量采用列举,而少使用 * 的方式
package com.powerise.hygeia.biz.medicare.ctrl;
import java.sql.*;
import java.util.*;
import com.powerise.hygeia.framework.*;
import com.powerise.hygeia.framework.exception.*;
1.2.3 类(Class)
u类的注释
作用:对类进行解释或说明
/**
* Copyright ® 2004 Powerise.
* All right reserved.
* Description: 获取登录用户的信息
* Author: powerise
* Create Date: 2004/09/14
* Modify Info:
* @version 1.0
*/
u类的定义
控制类继承BusiService类,实体类继承EntityInfo类。
public class CtBIZC000001LoginPassword extends BusiService {
public class EnBizInfo extends EntityInfo {
u成员变量(Class Fields)
proceted、private和 package 定义的成员变量
名字含义明确;
必要时加上说明
u构造方法
对于构造函数,应该用递增的方式写(比如:参数多的写在后面)。
访问类型("public","private" 等) 和任何 "static", "final" 或
"synchronized" 和方法和参数在一行,这样可以使方法和参数更易读。
public CounterSet(int size){
this.size = size;
}