Java 程式碼慣例 -- 第九章 命名慣例

9. 命名慣例

命名慣例讓程式更容易被理解和閱讀。他們也可以給予關於識別子功能的
資訊 -- 例如，是否為常數，套件，或是類別 -- 這可以在瞭解程式碼時很有
幫助。

變數型態　| 命名規則 範例n-------------------------------------------------------------------------
套件　　　| 獨一無二的套件名稱的前置字都 　　　com.sun.eng
　　　　　| 是使用所有都是小寫的 ASCII
　　　　　| 字母而且應該是頂層 DN 名稱，　　　com.apple.quicktime.v2
　　　　　| 目前有 com, edu, gov, mil,
　　　　　| net, org 或是 1981 年 ISO 　　　edu.cmu.cs.bovik.cheese
　　　　　| 標準 3166 中用來辨識國家的兩
　　　　　| 字母碼。
　　　　　|
　　　　　| 接下來的套件名稱元件根據組織
　　　　　| 擁有的內部命名慣例而不同。這
　　　　　| 種慣例會指定某種被分隔的目錄
　　　　　| 名稱元件，部門，計畫，機器，
　　　　　| 或是登入名稱。
　　　　　|
　　　　　|
類別　　　| 類別名稱應該是名詞，由每個內　　　class Raster;
　　　　　| 部單字開頭字母皆為大寫的混和　　　class ImageSprite;
　　　　　| 字組成。試著讓你的類別名稱是
　　　　　| 個很簡單的敘述。使用整個字 --
　　　　　| 避免用頭字語或是縮寫 (除非縮
　　　　　| 寫比長字的形式被用的更廣泛。
　　　　　| 例如 URL 或 HTML)。
　　　　　|
　　　　　|
介面　　　| 介面名稱應該像類別名稱的大寫　　interface RasterDelegate;
　　　　　| 法一樣。　　　　　　　　　　　　interface Storing;
　　　　　|
　　　　　|
方法　　　| 方法應該為動詞，混和第一個字　　run();
　　　　　| 母小寫和內部單字的第一個字母　　runFast();
　　　　　| 大寫的狀況。　　　　　　　　　　getBackground();
　　　　　|
　　　　　|
變數　　　| 除了變數之外，所有的實體，類　　int　　i;
　　　　　| 別，以及類別常數都是第一個字　　char　　c;
　　　　　| 母為小寫的混和狀況。內部單字　　float　　myWidth;
　　　　　| 則以大寫開頭。變數字不應以底
　　　　　| 線 _ 或是錢字號 $ 字元起始，
　　　　　| 就算這兩個都是被 Java 允許的。
　　　　　|
　　　　　| 變數名稱應該是短但仍有意義的
　　　　　| 。這變數名稱的選擇應該是幫助
　　　　　| 記憶的 -- 也就是說設計來讓不
　　　　　| 經意的觀察者都知道它使用的意
　　　　　| 圖。除了暫時使用後就被 "丟開"
　　　　　| 的變數名稱之外，應該避免使用
　　　　　| 單字元的變數。普遍使用的暫時
　　　　　| 變數名稱為用在整數的 i, j,
　　　　　| k, m, 和 n 以及用在字元的 e。
　　　　　|
　　　　　|
常數　　　| 宣告類別常數的變數名稱以及　　　static final int MIN_WIDTH = 4;
　　　　　| ANSI 常數的變數名稱應該是以　　static final int MAX_WIDTH = 999;
　　　　　| ("_") 底線分隔的全大寫字。(　　static final int GET_THE_CPU = 1;
　　　　　| 為了易於除錯，應該避免 ANSI
　　　　　| 常數。)
　　　　　|