命名Naming

編碼規範對於程序員尤為重要，可以有效的幫助我們進行Code Review，提高代碼的可讀性，讓其他人更快的理解代碼。一個軟件的生命週期中，80%的花費都在於維護，很多的時候都需要閱讀代碼，讀自己以前寫的代碼，讀別人寫的代碼，這樣規范代碼的優勢就顯示出來了，符合規範的代碼可以讓人簡單快速的理解理解代碼的意圖。

目錄：

1. Java類

2. 方法命名

3. 方法參數命名

4. 變量與參數的定義與命名

5. 元件宣告命名

6. XML元件id命名

7. 參數，變數與函數排序

8. 資源佈局文件命名（XML文件）

9. 枚舉(列舉)

10. 顏色資源檔案

11. 字串資源檔案

12. Style風格

一.Java類:

類名:大駝峰命名，所有單詞首寫字母大寫，並且類名最好為名詞，如果Activity類，以Activity為後綴

public class People{
}
public class LoginActivity{
}

二.方法命名:小駝峰，盡量動詞開頭:

public void getHome();

三.方法參數命名:小駝峰命名

public void isLogin(String loginName);

四.變量與參數的定義與命名:

變量應該定義在文件頭部的位置,並且應該遵循以下的命名規則.

靜態的常量應該都是以大寫字母加下劃線的格式命名

Private, protected ,pulbic非靜態變量應該以 m 開頭命名

public class MyClass {
    public static final int SOME_CONSTANT = 42;
    int mPackagePrivate;
    private int mPrivate;
    protected int mProtected;
}

五.元件宣告命名:

• 全域控件:m+View+功能

public Button mBtnLogin;

• 區域控件:View+功能

MeasureListView lvPqInfo = (MeasureListView) page.findViewById(R.id.vp_item_listview);

六.XML元件id命名:

layout中使用的id的單詞要全部小寫，單詞之間使用下劃線分割，使用名詞或者名詞詞組，應該通過id的命名可以直接理解當前的View要實現的功能

@+id/tv_username
@+id/btn_submit

七.參數，變數與函數排序:

每個 class 都應該按照一定的邏輯結構來排列基成員變量、方法、內部類等，從而達到良好的可讀性。

總體上來說，要按照先 public, 後 protected, 最後 private, 函數的排序也是。

八.資源佈局文件（XML文件）：

名稱為全部小寫，採用下劃線命名法

佈局文件應該和將要用於的 Android 組件的名稱相匹配，應以組件的名稱開頭。

例如， 如果我們為 SignInActivity,創建佈局文件，那佈局文件的名稱就應該為 activity_sign_in.xml.

九.枚舉:

全大寫，用下劃線分割，如下：

public enum BusinessTypeEnum {
INCOME(0),
PAY(1);
}

十.顏色資源檔案:

需定義在顏色資源檔案，檔名為colors.xml，當需要修改時，能同一修改。

定義規則為全小寫，用下劃線分割，並下註解<!--Class Name-->：

    <!--Fragment MonitorStation -->
    <color name="color_list_text">#262626</color>
    <color name="color_bg_select">#f4f3ed</color>

十一.字串資源檔案:

需定義在字串資源檔案，檔名為strings.xml，當需要修改時，能同一修改。

定義規則為全小寫，用下劃線分割，並下註解<!--Class Name-->：

    <!--Fragment MonitorStation -->
    <string name="all_supply">"全部給水廠"</string>
    <string name="all_value">"全部數值"</string>

十二.Style風格:

需定義在風格檔案，檔名為styles.xml，當需要修改時，能同一修改。

風格檔案，定義規則為大小駝峰式，並下註解<!--Class Name-->：

    <!--All class uses this style-->
    <style name="AppCustomTheme" parent="Theme.AppCompat.Light.NoActionBar">
        <item name="android:textAllCaps">false</item>
    </style>