Java 語言有一套完善的命名約定,有助於維護程式碼的可讀性和組織性。這些約定在 Java 語言規範 (JLS) 中有詳細記錄,可以分為排版約定和語法約定。
排版約定
排版命名約定涵蓋套件、類別、介面、方法、欄位和類型變數。遵循它們有助於保持程式碼的一致性並避免混淆,從而使其更易於使用和維護。最佳實務包括:
套件和模組:它們必須是分層的,用句點分隔並由小寫字母組成。在組織外部使用的套件必須以網域名稱向後開頭,例如 com.google 或 org.apache。
類別和介面:它們必須具有 PascalCase 名稱,例如 ArrayList 或 FutureTask,首選全名並避免縮寫,除非被廣泛接受(HttpUrl 而不是 HTTPURL)。
方法與欄位:以駝峰命名法命名,首字母小寫,例如remove或getCapacity。常數欄位(最終靜態)必須用大寫字母書寫,單字之間用下劃線分隔,例如 MAX_VALUE。
局部變數:可以使用縮寫和單一字符,例如 i、sum 或索引,特別是對於循環和臨時變數。
類型參數:通常是單一字母,例如 T 表示泛型類型,E 表示集合的元素類型,K 和 V 表示映射的鍵和值。
語法約定
語法約定根據標識符的類型而有所不同,重點在於提供元素功能的清晰度:
類別:使用名詞或名詞片語(Thread、ArrayList),而實用程式類別通常採用複數形式(Collections、Collectors)。
介面:介面名稱可以使用以「able」或「ible」結尾的名詞或形容詞,例如 Runnable 或 Comparable。
方法:動作函數的名稱是動詞(append、drawImage)。布林方法通常以 is 或 has (isEnabled, hasNext) 開頭。
getter 和 setter:傳回值的方法的名稱帶有名詞或以 get 開頭,而修改值的方法以 set 開頭。範例:getAge 和 setAge。
轉換方法:對於型別轉換,使用 toString 和 asList 等約定。靜態工廠通常以 from、of 或 getInstance 命名。
約定的重要性
遵守這些約定可以提高程式碼的可讀性和一致性,使團隊合作和維護變得更加容易。雖然排版約定更加嚴格,但語法約定具有更大的靈活性,允許程式設計師適應上下文和常規用法的需要。
以上是項目 採用普遍接受的命名約定的詳細內容。更多資訊請關注PHP中文網其他相關文章!