動力節點小編來告訴大家Java命名規則。

1.命名規范

命名規則

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

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

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

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

嚴禁使用關鍵詞命名;

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

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

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

命名需要簡潔，見名知意，通俗易懂;

(1)包的命名

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

(2)類的命名

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

類描述舉例

Activity類以Activity為后綴啟動頁面：LaunchActivity

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

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

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

Bean類以Bean為后綴新聞實體類：NewsBean

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

工具類以Util為后綴網絡工具類：NetWorkUtil

Service類以Service為后綴音頻服務：AudioService

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

ContentProvider類以Provider為后綴聯系人的內容提供者：ContactsProvider

Dialog類以Dialog為后綴加載：LoadingDialog

監聽器類以Listener為后綴網絡監聽：NetWorkListener

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

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

管理類以Manager為后綴聯系人管理類：ContactsManager

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

(3)接口的命名

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

(4)變量命名

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

private TextView tvUserName;。

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

常見控件的縮寫如下：

控件縮寫控件縮寫

TextViewtvEditTextet
ButtonbtnImageViewiv
ListviewlvRecyclerViewrv
GridViewgvWebViewwv
LinearlayoutllRlativeLayoutrl
FrameLayoutflScrollViewsv
ProgressBarpbImageButtonib
CheckBoxcbRadioButtonrb
RadioGrouprgSeekBarsb
VideoViewvvSurfaceViewsv

(5)常量的命名

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

publicstaticfinalintREQUEST_KEY_CODE =1;

(6)方法的命名

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

(7)資源文件命名

全部小寫，并通過下劃線連接。

1)布局文件的命名

以對應的類別名稱為前綴，然后緊跟模塊包名，最后是邏輯名稱，他們之間通過下劃線連接。

常見的命名如下：

布局類型布局前綴舉例

Activityactivity_模塊名_求助主頁面：activity_sos_main

Fragmentfragment_模塊名_論壇推薦：fragment_tribune_recommend

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

Dialogdialog_論壇詳情頁回復：dialog_tribune_reply

Includeinclude_全局通用的標題欄：include_global_title

2)動畫資源文件命名

動畫效果命名風格

淡入/淡出fade_in/fade_out

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

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

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

3)value中name命名

 strings.xml

命名格式：string_模塊名_邏輯功能，例如：啟動頁面的跳過：

name="string_launch_jump">跳過

colors.xml

命名格式：color_顏色值，其實顏色值是16進制，例如：白色:

name="color_ffffff">#FFFFFF

styles.xml

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

dimens.xml

文字：font_字號，字號單位是sp;

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

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

代碼如下：

18sp16dp48dp24dp

2.格式規范

(1)大括號的使用

大括號的開始在代碼塊開始的行尾，結束在代碼塊同一縮進的行首;

條件語句一定使用大括號;

左大括號前不換行，右大括號前換行，除了if-else，try-catch;

大括號內沒有任何代碼，不換行。

(2)空格的使用

表示分隔時用一個空格;

運算符兩邊用一個空格隔開;

逗號語句后面如果不換行，也用一個空格。

3.注釋

(1)類、接口注釋

使用多行注釋的方式，規則如下：

/**
* Author：開發人員姓名
* Email：開發人員郵箱
* Description:? 描述該類/接口實現的具體功能
* Date: 2017/4/20 14:16? 創建該類的時間
*/

(2)方法注釋

1)整體方法注釋

使用多行注釋的方式，規則如下：

/*** 描述方法實現的功能*@params  說明參數含義*@return說明返回值含義*/

2)方法內部注釋

方法內部單行注釋，在被注釋語句上方另起一行，使用“//”注釋。

方法內部注釋，使用/* ... */注釋。

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

(3)變量注釋

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

(4)xml注釋

<!--注釋內容-->