動(dòng)力節(jié)點(diǎn)小編來(lái)告訴大家Java命名規(guī)則。

1.命名規(guī)范

命名規(guī)則

大駝峰命名(UpperCamelCase)：每個(gè)單詞的第一個(gè)字母大寫，其他字母小寫。

小駝峰命名(lowerCamelCase)：如果僅有一個(gè)單詞，那么所有字母全部小寫，如果是兩個(gè)及以上的單詞組成的名稱，那么除了第一個(gè)單詞是全部小寫外，其他但是的首字母大寫，其他字母小寫。

所有的命名都應(yīng)該以字母(A-Z或者a-z)、美元符($)或者下劃線(_)開始;

首字符之后可以是字母(A-Z或者a-z)、美元符($)或者下劃線(_)或者數(shù)字的任何字符組合;

嚴(yán)禁使用關(guān)鍵詞命名;

嚴(yán)禁使用拼音與英文的混合方式命名，更不允許使用中文的方式命名;

命名盡量使用英文，除了通用的拼音(Beijing)可視為英文，其他的拼音都不是英文;

命名除了常見的英文縮寫，盡量避免使用縮寫;

命名需要簡(jiǎn)潔，見名知意，通俗易懂;

(1)包的命名

包的命名由全部小寫的單詞組成。一般使用公司的域名的作為自己程序包的唯一前綴，使用倒域名規(guī)則，例如：com.baidu.項(xiàng)目名，然后針對(duì)每個(gè)具體的模塊在區(qū)分每個(gè)模塊包名，例如：論壇模塊的整體包名：com.baidu.項(xiàng)目名.tribune。

(2)類的命名

類的命名遵循大駝峰命名的規(guī)則，常見類的命名規(guī)則如下：

類描述舉例

Activity類以Activity為后綴啟動(dòng)頁(yè)面：LaunchActivity

Fragment類以Fragment為后綴論壇推薦列表：TribuneRecommendFragment

Adapter類以Adapter為后綴論壇適配器：TribuneAdapter

ViewHolder類以ViewHolder為后綴廣告類型：AdViewHolder

Bean類以Bean為后綴新聞實(shí)體類：NewsBean

Model類以Model為后綴論壇推薦Model：TribuneRecommendModel

工具類以Util為后綴網(wǎng)絡(luò)工具類：NetWorkUtil

Service類以Service為后綴音頻服務(wù)：AudioService

BroadcastReceiver 類以Receiver為后綴音頻廣播：AudioReceiver

ContentProvider類以Provider為后綴聯(lián)系人的內(nèi)容提供者：ContactsProvider

Dialog類以Dialog為后綴加載：LoadingDialog

監(jiān)聽器類以Listener為后綴網(wǎng)絡(luò)監(jiān)聽：NetWorkListener

自定義基礎(chǔ)類以Base為前綴例如：BaseActivity，BaseFragment

抽象類以 Abstract或者Abs為前綴例如：AbsBean

管理類以Manager為后綴聯(lián)系人管理類：ContactsManager

解析類以Parser為后綴新聞Json解析類： NewsJsonParser

(3)接口的命名

接口命名遵循大駝峰命名的規(guī)則，以大寫的I開頭，表示這是一個(gè)接口，以able或ible截尾。

(4)變量命名

變量的命名遵循小駝峰命名的規(guī)則，其中控件的變量建議使用控件縮寫+邏輯名稱的格式，例如：

private TextView tvUserName;。

其中布局中每個(gè)控件的id命名為控件縮寫_邏輯名稱,例如：tv_user_name。

常見控件的縮寫如下：

控件縮寫控件縮寫

TextViewtvEditTextet
ButtonbtnImageViewiv
ListviewlvRecyclerViewrv
GridViewgvWebViewwv
LinearlayoutllRlativeLayoutrl
FrameLayoutflScrollViewsv
ProgressBarpbImageButtonib
CheckBoxcbRadioButtonrb
RadioGrouprgSeekBarsb
VideoViewvvSurfaceViewsv

(5)常量的命名

常量名稱的每個(gè)單詞都大寫，并且每個(gè)單詞之間通過(guò)下劃線(_)連接，例如：

publicstaticfinalintREQUEST_KEY_CODE =1;

(6)方法的命名

方法的命名遵循小駝峰命名的規(guī)則，以動(dòng)詞+名詞的方式組成，例如初始化view：initView()。

(7)資源文件命名

全部小寫，并通過(guò)下劃線連接。

1)布局文件的命名

以對(duì)應(yīng)的類別名稱為前綴，然后緊跟模塊包名，最后是邏輯名稱，他們之間通過(guò)下劃線連接。

常見的命名如下：

布局類型布局前綴舉例

Activityactivity_模塊名_求助主頁(yè)面：activity_sos_main

Fragmentfragment_模塊名_論壇推薦：fragment_tribune_recommend

列表itemitem_模塊名_論壇推薦：item_tribune_recommend

Dialogdialog_論壇詳情頁(yè)回復(fù)：dialog_tribune_reply

Includeinclude_全局通用的標(biāo)題欄：include_global_title

2)動(dòng)畫資源文件命名

動(dòng)畫效果命名風(fēng)格

淡入/淡出fade_in/fade_out

從某個(gè)方向淡入/淡出fade_方向_in(out)

從某個(gè)方向彈入/彈出push_方向_in(out)

從某個(gè)方向滑入/滑出slide_方向_in(out)

3)value中name命名

 strings.xml

命名格式：string_模塊名_邏輯功能，例如：?jiǎn)?dòng)頁(yè)面的跳過(guò)：

name="string_launch_jump">跳過(guò)

colors.xml

命名格式：color_顏色值，其實(shí)顏色值是16進(jìn)制，例如：白色:

name="color_ffffff">#FFFFFF

styles.xml

遵循大駝峰命名的規(guī)則，XXXStyle，例如：LoadingStyle。

dimens.xml

文字：font_字號(hào)，字號(hào)單位是sp;

距離：space_距離值，距離單位是dp;

控件的寬高：具體控件width/height寬高值，寬高值單位是dp。

代碼如下：

18sp16dp48dp24dp

2.格式規(guī)范

(1)大括號(hào)的使用

大括號(hào)的開始在代碼塊開始的行尾，結(jié)束在代碼塊同一縮進(jìn)的行首;

條件語(yǔ)句一定使用大括號(hào);

左大括號(hào)前不換行，右大括號(hào)前換行，除了if-else，try-catch;

大括號(hào)內(nèi)沒(méi)有任何代碼，不換行。

(2)空格的使用

表示分隔時(shí)用一個(gè)空格;

運(yùn)算符兩邊用一個(gè)空格隔開;

逗號(hào)語(yǔ)句后面如果不換行，也用一個(gè)空格。

3.注釋

(1)類、接口注釋

使用多行注釋的方式，規(guī)則如下：

/**
* Author：開發(fā)人員姓名
* Email：開發(fā)人員郵箱
* Description:? 描述該類/接口實(shí)現(xiàn)的具體功能
* Date: 2017/4/20 14:16? 創(chuàng)建該類的時(shí)間
*/

(2)方法注釋

1)整體方法注釋

使用多行注釋的方式，規(guī)則如下：

/*** 描述方法實(shí)現(xiàn)的功能*@params  說(shuō)明參數(shù)含義*@return說(shuō)明返回值含義*/

2)方法內(nèi)部注釋

方法內(nèi)部單行注釋，在被注釋語(yǔ)句上方另起一行，使用“//”注釋。

方法內(nèi)部注釋，使用/* ... */注釋。

注釋與代碼要對(duì)齊，*及// 與其后面的文字之間空一格。

(3)變量注釋

使用單行注釋的方式，使用“//”注釋，在變量后面天啊及，如果注釋太長(zhǎng)，在變量上方添加。

(4)xml注釋

<!--注釋內(nèi)容-->