3.1 规则
规则1 方法、属性、变量、常量等命名应具有指导意义,严禁出现int1、str3、task5等随意的命名,违者重罚。
规则2 类名和接口使用意义完整的英文描述,每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。
示例:OrderInfomation, CustomerList, LogManager, LogConfig, SmpTransaction
规则3 方法名使用类意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。
示例:
private void calculateRate();
public void addOrder();
规则4 方法中,存取属性的方法采用setter和getter方法,动作方法采用动词和动宾结构,事件触发采用 “on + 动词” 方法。
getter/setter方法:
get + 非布尔类型名()
is + 布尔类型名()
set + 属性名()
动词结构:
动词()
动词 + 宾语()
事件触发方法:
on + 动词()
示例:
public String getType();
public boolean isFinished();
public void setVisible(boolean visible);
public void show();
public void addKeyListener(KeyListener listener);
public void onClick();
public void onItemClick();
规则5 属性名使用意义完整的英文描述,第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。
示例:
private customerName;
private orderNumber;
private smpSession;
规则6 常量名使用全大写的英文描述,英文单词之间用下划线分隔开,并且使用 static final修饰。
示例:
public static final int MAX_VALUE = 1000;
public static final String DEFAULT_START_DATE = "2015-12-08";
规则7 对于定长数组,数组中每个元素都有特定含义的,必须定义数组每个元素下标为常量。
示例:经常使用的数组,比如查询结果数组,String[] result。
private static final int RESULT_PAGE_NUM = 0;
private static final int RESULT_COUNT = 1;
private static final int RESULT_CURRENT_PAGE = 2;
...
private String[] parseResult() {
String[] result = getResult();
int recordCount = result[RESULT_COUNT];
int currrntPage = result[RESULT_CURRENT_PAGE];
int pageNum = result[RESULT_PAGE_NUM];
}
private String[] getResult() {
...
}