一般性命名原則
Posted by Bruce Tsai
命名法介紹
類別的命名原則
- 主要採
Pascal Case或Upper Camel Case命名法
public class Stringifier {
// code here
}
介面的命名原則
- 以大寫
I開頭，後續接介面名稱，主要採Pascal Case或Upper Camel Case命名法
public interface IStringify {
// method or constant here
}
常數的命名原則
- 類別(class)常數：以大寫字母組成，中間以底線分隔
public interface IHttpRequestHeader {
/**
* Content_Types that are acceptable for the response.
*/
String ACCEPT = "Accept";
/**
* Character sets that are acceptable
*/
String ACCEPT_CHARSET = "Accept-Charset";
/**
* List of acceptable encodings.
*/
String ACCEPT_ENCODING = "Accept-Encoding";
}
- 實體(instance)常數：採
Lower Camel Case命名法
public class Counter {
/**
* 最大值
*/
final int maxSize = 100;
/**
* 最小值
*/
final int minSize = 1;
}
成員／屬性(Field)的命名原則
Lower Camel Case命名法- 以
m或_開頭的Pascal Case命名法
註：命名原則需統一不可混用
public class Human {
String firstName;
Date birthday;
}
或
public class Person {
String mFirstName;
Date mBirthday;
}
方法的命名原則
Lower Camel Case命名法
public class Tester {
public boolean addExecution(Execution execution) {
// code here
}
protected void printObject(Object obj){
// code here
}
}
區域變數的命名原則
Lower Camel Case命名法- 包含型別的
Pascal Case命名法
註：命名原則需統一不可混用
public static void main(String[] args) {
int count = 100;
String serviceUrl = "http://www.somewhere.com/service";
}
或
public static void main(String[] args) {
int intCount = 100;
String strServiceUrl = "http://www.somewhere.com/service";
}