Java命名規(guī)則詳細(xì)總結(jié)
1. JAVA源文件的命名 JAVA源文件名必須和源文件中所定義的類的類名相同。
2. Package的命名 Package名的第一部分應(yīng)是小寫ASCII字符,并且是頂級(jí)域名之一,通常是com、edu、gov、mil、net、org或由ISO標(biāo)準(zhǔn)3166、1981定義的國家唯一標(biāo)志碼。Package名的后續(xù)部分由各組織內(nèi)部命名規(guī)則決定,內(nèi)部命名規(guī)則指定了各組件的目錄名,所屬部門名、項(xiàng)目名等。
3. Class/Interface的命名 Class名應(yīng)是首字母大寫的名詞。命名時(shí)應(yīng)該使其簡潔而又具有描述性。異常類的命名,應(yīng)以Exception結(jié)尾。Interface的命名規(guī)則與Class相同。
4. 常量的命名 常量名的字母應(yīng)全部大寫,不同的單詞之間通過下劃線進(jìn)行連接,并且名字組合應(yīng)該賦予含義。
5. 變量的命名
5.1 普通變量 普通變量名的首字母小寫,其它每個(gè)單詞的首字母大寫。命名時(shí)應(yīng)該使其簡短而又有特定含義,簡潔明了的向使用者展示其使用意圖。
5.2 約定變量 所謂約定變量,是指那些使用后即可拋棄(throwaway)的臨時(shí)變量。通常i、j、k、m和n代表整型變量;c、d和e代表字符型變量。
6. 方法的命名 方法名的第一個(gè)單詞應(yīng)是動(dòng)詞,并且首字母小寫,其它每個(gè)單詞首字母大寫。
7. 方法參數(shù)的命名 應(yīng)該選擇有意義的名稱作為方法的參數(shù)名。如果可能的話,選擇和需要賦值的字段一樣的名字。
補(bǔ)充資料:
1、類名首字母應(yīng)該大寫。屬性(成員變量)、方法、對(duì)象變量以及所有標(biāo)識(shí)符(如形式參數(shù)、實(shí)際參數(shù)、局部變量)的首字母應(yīng)小寫,其中包含的所有單詞都應(yīng)緊靠在一起,而且大寫中間單詞的首字母。例如:
類名:ThisIsAClassName 屬性或方法名:thisIsMethodOrFieldName對(duì)象變量:thisIsAClassVariable
2、Java 包(Package)屬于一種特殊情況,它們?nèi)际切懽帜?,即便中間的單詞亦是如此。對(duì)于全局包,將你的Internet 域名反轉(zhuǎn)并接上包名。例如:
cn.edu.usst.dingyuewei.package。
另外,package 行要在import 行之前,import 中標(biāo)準(zhǔn)的包名要在本地的包名之前,而且按照字母順序排列。如果import 行中包含了同一個(gè)包中的不同子目錄,則應(yīng)該用 * 來處理。例如:
package hotlava.net.stats;
import java.io.*;
import java.util.Observable;
import hotlava.util.Application;
這里 java.io.* 是用來代替InputStream and OutputStream 的。
3、接口(Interface):采用完整的英文描述符說明接口封裝,所有單詞的第一個(gè)字母大寫。習(xí)慣上,名字后面加上后綴 able, ible 或者 er。例如:Contactable,Prompter。
4、組件(Component)使用完整的英文描述來說明組件的用途,末端應(yīng)接上組件類型。例如:okButton,customerList,fileMenu。
5、類中常用方法的命名:
a)類的獲取方法(一般具有返回值)一般要求被方法名使用被訪問字段名,前面加上前綴get,例如getFirstName(), getLastName()。
b)類的布爾型的判斷方法一般要求方法名使用單詞 is 做前綴,如isPersistent(),isString()?;蛘呤褂镁哂羞壿嬕饬x的單詞,例如equal 或equals
c)類的設(shè)置方法(一般返回類型為void):被訪問字段名的前面加上前綴 set,例如setFirstName(),setLastName(),setWarpSpeed()
d)類的普通方法一般采用完整的英文描述說明成員方法功能,第一個(gè)單詞盡可能采用一個(gè)生動(dòng)的動(dòng)詞,第一個(gè)字母小寫,例如 openFile(), addAccount()。
e)構(gòu)造方法應(yīng)該用遞增的方式寫(比如:參數(shù)多的寫在后面)。例如:
public CounterSet(){}
public CounterSet(int size){ this.size = size;}
f)toString 方法:一般情況下,每一個(gè)類都應(yīng)該定義toString 方法,其格式為:public String toString() {…}
g)一般應(yīng)考慮置入一個(gè)main()方法,其中包含用于測試那個(gè)類的代碼,如果包含了main() 方法, 那么它應(yīng)該寫在類的底部。
6、靜態(tài)常量字段(static final)一般全部采用大寫字母,單詞之間用下劃線分隔(也有特例,如Java 類庫中關(guān)于顏色的常數(shù)沒有嚴(yán)格地全部使用大寫字母)。例如MIN_BALANCE,DEFAULT_DATE。
7、循環(huán)計(jì)數(shù)變量通常采用字母 i,j,k 或者 counter。而數(shù)組應(yīng)該總是用下面的方式來命名:objectType[]或 byte[] buffer。
相關(guān)文章
Java 8中map()和flatMap()方法區(qū)別詳解
這篇文章主要為大家介紹了Java 8中map()和flatMap()方法區(qū)別詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-07-07Mybatis-Plus的應(yīng)用場景描述及注入SQL原理分析
MyBatis-Plus是一個(gè) MyBatis 的增強(qiáng)工具,在 MyBatis 的基礎(chǔ)上只做增強(qiáng)不做改變,為簡化開發(fā)、提高效率而生,本文重點(diǎn)給大家介紹Mybatis-Plus的應(yīng)用場景及注入SQL原理分析,感興趣的朋友跟隨小編一起學(xué)習(xí)吧2021-05-05Mybatis開發(fā)環(huán)境搭建實(shí)現(xiàn)數(shù)據(jù)的增刪改查功能
這篇文章主要介紹了 Mybatis開發(fā)環(huán)境搭建實(shí)現(xiàn)數(shù)據(jù)的增刪改查功能,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2017-03-03Java代碼實(shí)現(xiàn)簡單酒店管理系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了Java代碼實(shí)現(xiàn)簡單酒店管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-06-06Spark隨機(jī)森林實(shí)現(xiàn)票房預(yù)測
這篇文章主要為大家詳細(xì)介紹了Spark隨機(jī)森林實(shí)現(xiàn)票房預(yù)測,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-08-08