Java 代碼規範[持續更新中]

Java 代碼規範

1. Java 命名約定

  類名、接口名的第一個字母要大寫。

1.1 通常概念

  * 儘可能使用完整的英文描述符

  * 採用適用於相關領域的術語

  * 採用大小寫混合使名字可讀

  * 儘可能少用縮寫,但若是用了,最好加上註釋便於理解

  * 避免使用太長的名字

  * 避免使用相似的名字,或者僅僅是大小寫不一樣的名字


1.2 示範

  包(Package) 採用完整的英文描述符,應該都是由小寫字母組成。

  類(Class) 採用完整的英文描述符,全部單詞的第一個字母大寫。 如:
      Person     Car

  接口(Interface) 採用完整的英文描述符說明接口封裝,全部單詞的第一個字母大寫。習慣上,名字後面加上後綴 able, ible 或者 er,但這不是必需的。如:
      Contactable   Prompter

  組件/部件(Component) 使用完整的英文描述來講明組件的用途,末端應接上組件類型。 如:
      okButton
      fileMenu

  異常(Exception) 一般採用字母 e 表示異常。

  獲取成員函數 被訪問字段名的前面加上前綴 get。函數

                如:getFirstName(), getLastName()

       布爾型的獲取成員函數 全部的布爾型獲取函數必須用單詞 is 作前綴。spa

                 如: isPersistent(), isString()

    設置成員函數 被訪問字段名的前面加上前綴 set。代碼規範

                        setFirstName(), setLastName(),setWarpSpeed()

    普通成員函數 採用完整的英文描述說明成員函數功能,第一個單詞儘量採用動詞,第一個字母小寫。接口

                        openFile(), addAccount()

     靜態常量字段(static final) 所有采用大寫字母,單詞之間用下劃線分隔。get

                   MIN_BALANCE, DEFAULT_DATE
    
     循環計數器 一般採用字母 i,j,k 或者 counter 均可以接受。 i, j, k, counter



8.8.8其餘經常使用公司規範:io

 (1)常量通常放在前面,變量放在後面,如:if("abc"==str)      null!=x等等寫法,table

            目的是爲了防止筆誤遺漏符號寫成  str="abc"     x=null。ast

相關文章
相關標籤/搜索