關於命名(naming)原則

以下列出目前全世界公認最好的命名慣例:

      Java 語言建議的命名慣例        

9. 命名慣例 (Naming Conventions)
9.1 Java 命名慣例 (Java naming convention)
命名慣例讓程式更容易被理解和閱讀。

它們也可以給予關於識別子功能的資訊，例如，

一看名稱就知道是否為常數，套件，或是類別，這可以在瞭解程式碼時很有幫助。

一般建議：

  
使用完整的、能夠望文生義的英文。 
  
使用跟該領域相關的術語。 
  
大小寫混合使用，以增加可讀性，例如 gotoAndPlay(38);。 
  
名稱儘量不要超過 15 個字符(character; 字元)。 
  
不要只用大小寫的差異來辨別兩個變數名稱，這樣容易造成混淆。 

  

  

    
項目
    
命名慣例
    
範例
  

    
Packages
套件
    
套件(package)名稱應該用全部小寫的ASCII字母，
而且應該是top-level 的網域名稱之一(目前有com,edu,gov,mil,net,org 或者是由1981年ISO Standard 3166所定義由兩個英文字母來代表國家的識別碼。)
為了避免和其他套件名稱衝突，
一般會將公司或組織的 nternet 網域名稱順序顛倒過來，再加上套件名稱，不用把網域名稱的每個部分都加進去，用一個或兩個就行了。

  注意 Android Java programming 規定套件名稱至少要兩個英文單字, 例如 com.google 是正確套件名稱;
還要注意, 要上傳到 Google Play(以前的Android Market)的每個APP程式的package name必須是唯一。
    
java.awt,
com.oracle.utility
      
com.google.android.v4
      
flash.events
      
flash.display
     
  

    
Class
類別
    
類別名稱應該是名詞，類別名稱可混合大小寫，但類別名稱開頭第一個字要大寫。
     類別名要簡單容易描述,儘量少用縮寫或略稱，除非是URL ,HTML等廣泛使用的字。
     
    
Clock, Cake, MovieClip

  

    
Interface
介面
    
跟類別的命名規則完全相同，使用完整的英文，介面名稱的每個單字的第一個字母都大寫，其餘小寫。
      如果可能的話，儘量使用形容詞，也就是 'able'，'ible' 等字尾的名稱（不是絕對必要）。
    
Runnable, Contactable, Clonable
  

    
Compilation unit 
      files
檔案命名
    
以類別(或介面)名稱作為主檔名，附屬檔名為小寫的'.java'。
    
Clock.java, MouseEvent.java



  

    
Member 
      functions
成員函數
或稱方法(Method)
    
函數(function, 函式)又稱方法(Method), 使用完整的英文，
最好是用動詞命名，用小寫字母開頭，如果是多個英文單字(word)連起來，
第一個單字的第一個字母小寫，其餘的單字的第一個字母大寫，就是說斷字的地方字母大寫。
      
注意: 建構子Constructor 這函數比較特別,
      其名稱以及大小寫必須與類別名稱完全相同。
    
openFile( ), addChild( ),
getMoney( )

  

    
Setter 
  成員函式
    
把要存取的欄位名稱前面冠上 'set'。
    
setFirstName(),
setLastName()

  

    
Getter 
  成員函式
    
把要存取的欄位名稱前面冠上 'get'。
    
getFirstName(),
getLastName()

  

    
傳回布林型態的 getter 
      成員函式
    
開頭一律冠上 'is'。
    
isDead, isString, isFailed




  

    
Fields/properties
       
欄位/屬性
    
 所謂欄位或屬性(property, attribute)又稱
成員資料(member data), 包括變數與常數, 請參考以下變數與常數命名。
    


  

    
Variables  
變數
    
 
變數名稱不應該以底線(_)或dollar sign($)開頭，雖然那樣還是正確但不好。
變數名稱要短且有意義，
除了臨時變數之外，要儘量避免使用一個字元的變數名稱。
若是臨時變數, 一般是用i, j, k, m, n來代表整數，x, y, z 代表實數，
c, d 代表文字符號(character; 字符或稱字元)。
     
    
 int  age; 
int  myMoney;

double  delta;

  int  i, k, n; 
 


  

    
Parameters
參數
    
參數就是寫在函數名稱 之後小括號內的
變數, 原則上命名方式與變數相同; 使用完整的英文來描述傳遞的變數/物件，
      可在前面冠上 'a' 或 'an'，不管用哪種方式，最重要的是定好後大家就要遵守它。
    
customer, account 或
aCustomer, 
  anAccount

  

    
Exceptions
異常或例外
    
通常以小寫字母 'e' 代表異常物件變數。
    
e 或 ex 

  

    
Final static fields 
      (consants)
常數
    
全部使用大寫英文字母，每個單字之間用底線分隔。
    
NUMBER_STUDENT,
MOUSE_OVER, ENTER_FRAME


  

    
Loop 
      counters
迴圈計數器
    
通常以 i, j, k 或 counter 來命名。
    
i, j, k, cnt, counter

  

    
Local 
      variables
區域變數
或稱局部變數
    
原則上區域變數使用完整的英文，第一個單字(word)的第一個字母小寫，其餘的單字的第一個字母大寫。
     
注意：應避免和類別的欄位名稱相同，以免產生混淆，例如，你有一個欄位名稱是 
      'firstName'，那麼在成員函式中的區域變數就不要取相同的名稱。
    
totalMoney, tempSum, tmpString
 



註:
    區域變數(Local variable; 局部變數; 函數內的變數)的命名可以稍有彈性，
    對於比較不重要的變數，可以採取如 i, j, k, m, n, tmp 等簡短的命名方式，
    但請特別注意，不要隨意亂用，原則上仍應該儘量以完整的英文來命名。
    下表列出一些建議的臨時變數命名:



  

  

    
變數類型
    
建議的命名慣例
  

    
char 字符(字元)
    
c 或 ch
  

    
String 字串
    
str 或 s 或 tmpStr
  

    
代表有幾個
    
n 或 k
  

    
length 長度
    
len
  

    
offset 位移整數
    
off
  

    
float 實數
    
f 或 x 或 y
  

    
double 實數
    
d 或 x 或 y
  

    
Object 物件
    
o 或 obj





關於完整的程式寫作慣例(Coding Convention)建議:
   請看http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html

或是點這裡看翻譯的中文版(會換掉此頁; 按左上角可回到此頁)


或是點這裡看翻譯的中文版(會另開新頁)

Go back
 Top