JAVA代碼書寫規范有哪些

JAVA代碼書寫規范有哪些，針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

一般原則

1. 盡量使用完整的英文描述符  采用適用于相關領域的術語  采用大小寫混合增強可讀性  盡量少用縮寫，但如果用了，要明智地使用，且在整個工程中統一  避免使用長的名字  避免使用類似的名字，或者僅僅是大小寫不同的名字  避免使用下劃線（除靜態常量等）

命名的字母大小寫問題

1. 包名： 字母全小寫 例如: cn.coderstory.Activity.Main  類，接口 ：首字母大寫，其他全小寫 例如: class Container  方法，變量 ：第二個單詞開始首字母大寫 例如: seedMessage  常量： 大寫，單詞用“_”分割 例如: final static MIN_WIDTH = 4  接口 ：首字母大寫 ，后綴Impl 例如: class ContainerImpl  異常類： 首字母大寫， 后綴Exception 例如: DataNotFoundException  抽象類 ：首字母大寫， 前綴Abstract 例如: AbstractBeanDefinition  Test類： 首字母大寫， 后綴Test 例如: public Location newLocation()

方法的命名

1. 類中獲取值方法，一般要求被方法名使用被訪問字段名，前面加上前綴get，如getLastUser(), getUserCount()  返回布爾型的判斷方法一般要求方法名使用單詞 is 做前綴，如isPersistent(),isString()。或者使用具有邏輯意義的單詞，例如equal 或equals  用于修改某些設置的方法（一般返回類型為void）：被訪問字段名的前面加上前綴 set，如setFirstName(),setLastName()，setWarpSpeed()。  已辦的方法一般采用完整的英文描述說明成員方法功能，第一個單詞盡可能采用一個生動的動詞，第一個字母小寫，如 openFile(), addAccount()。  接口 ：首字母大寫 ，后綴Impl 例如: class ContainerImpl  異常類： 首字母大寫， 后綴Exception 例如: DataNotFoundException  抽象類 ：首字母大寫， 前綴Abstract 例如: AbstractBeanDefinition  Test類： 首字母大寫， 后綴Test 例如: public Location newLocation()

Java注釋約定

類的整體注釋：遵循JavaDoc的規范，在每一個源文件的開頭注明該CLASS的作用, 作簡要說明, 并寫上源文件的作者, 編寫日期。如果是修改別人編寫的源文件，要在修改信息上注明修改者和修改日期。

例如：

/*** @（#）:CLASSNAME.java* @description: Description of this java* @author: PROGRAMMER'S NAME YYYY/MM/DD* @version: Version No.* @modify:* @Copyright: 版權由擁有*/

類中方法的注釋：遵循JavaDoc的規范，在每個方法的前部用塊注釋的方法描述此方法的作用，以及傳入，傳出參數的類型和作用，以及需要捕獲的錯誤。

例如：

/*** 方法的描述***@param 參數的描述*@return 返回類型的描述*@exception 出錯信息的描述*/

行注釋：使用//…的注釋方法來注釋需要表明的內容。并且把注釋的內容放在需要注釋的代碼的前面一行或同一行。    塊注釋：使用/**和*/注釋的方法來注釋需要表明的內容。并且把注釋的內容放在需要注釋的代碼的前面。    注釋哪些部分：類的目的（即類所完成的功能）、設置接口的目的以及應如何被使用、成員方法注釋（對于設置與獲取成員方法，在成員變量已有說明的情況下，可以不加注釋；普通成員方法要求說明完成什么功能，參數含義是什么？返回什么？）、普通成員方法內部注釋（控制結構、代碼做了些什么以及為什么這樣做，處理順序等）、實參和形參的含義以及其他任何約束或前提條件、字段或屬性描述。而對于局部變量，如無特別意義的情況下不加注釋。

JAVA文件聲明順序

類或接口應該按以下順序聲明（其實是加載順序的問題）：

1. 包的定義  impot類（輸入包的順序、避免使用*）輸入包應該按照java.*.*，javax.*.*，org.*.* ，com.*.*的順序import在import的時候不應該使用* (例如: java.util.*)  類或接口的定義  靜態變量定義，按public，protected，private順序  實例變量定義，按public，protected，private順序  構造方法  方法定義順序按照public方法(類自己的方法)，實現接口的方法，重載的public法，受保護方法，包作用域方法和私有方法。建議：類中每個方法的代碼行數不要超過100行。  內部類的定義

關于JAVA代碼書寫規范有哪些問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注億速云行業資訊頻道了解更多相關知識。