原標題：Android開發規范

一.書寫規范

1. 編碼方式統一用UTF-8.

2. 花括號不要單獨一行，和它前面的代碼同一行。而且，花括號與前面的代碼之間用一個空格隔開。

3. 空格的使用

if、else、for、switch、while等邏輯關鍵字與后面的語句留一個空格隔開。

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

方法的每個參數之間用一個空格隔開。

4.空行的使用

將邏輯相關的代碼段用空行隔開，以提高可讀性。空行也只空一行，不要空多行。在以下情況需用一個空行：

兩個方法之間

方法內的兩個邏輯段之間

方法內的局部變量和方法的第一條邏輯語句之間

常量和變量之間

5.當一個表達式無法容納在一行內時，可換行顯示，另起的新行用8個空格縮進。

6.一行聲明一個變量，不要一行聲明多個變量，這樣有利于寫注釋。

7.使用快捷鍵進行代碼自動格式化。

Windows：CTRL+ALT+L

Mac：OPTION+COMMAND+L

8.一個方法最多不要超過40行代碼。

9.范圍型的常量用枚舉類定義，而不要直接用整型或字符，這樣可以減少范圍值的有效性檢查。

10.文字大小的單位統一用sp，元素大小的單位統一用dp。

11. 應用中的字符串統一在strings.xml中定義，然后在代碼和布局文件中引用。

12. 顏色值統一在colors.xml中定義，然后在代碼和布局文件中引用。另外，不要在代碼和布局文件中引用系統的顏色，除了透明。

二.命名規范

1. 包命名

域名反寫+項目名稱+模塊名稱，全部單詞用小寫字母。

2. 類和接口命名

使用大駝峰規則，用名詞或名詞詞組命名，每個單詞的首字母大寫。

以下為幾種常用類的命名：

activity類，命名以Activity為后綴，如：LoginActivity

fragment類，命名以Fragment為后綴，如：ShareDialogFragment

service類，命名以Service為后綴，如：DownloadService

adapter類，命名以Adapter為后綴，如：CouponListAdapter

工具類，命名以Util為后綴，如：EncryptUtil

模型類，命名以BO為后綴，如：CouponBO

接口實現類，命名以Impl為后綴，如：ApiImpl

3. 方法命名

使用小駝峰規則，用動詞命名，第一個單詞的首字母小寫，其他單詞的首字母大寫。

以下為幾種常用方法的命名：

初始化方法，命名以init開頭，例：initView

按鈕點擊方法，命名以to開頭，例：toLogin

設置方法，命名以set開頭，例：setData

具有返回值的獲取方法，命名以get開頭，例：getData

通過異步加載數據的方法，命名以load開頭，例：loadData

布爾型的判斷方法，命名以is或has，或具有邏輯意義的單詞如equals，例：isEmpty

4. 控件縮寫

5. 常量命名

全部為大寫單詞，單詞之間用下劃線分開。

1

publicfinalstaticintPAGE_SIZE =20;

6. 變量命名

{范圍描述+}意義描述+類型描述的組合，用駝峰式，首字母小寫。

1

2

3

privateTextView headerTitleTxt;// 標題欄的標題

privateButton loginBtn;// 登錄按鈕

privateCouponBO couponBO;// 券實例

7. 控件id命名

控件縮寫_{范圍_}意義，范圍可選，只在有明確定義的范圍內才需要加上。

1

2

3

4

5

6

7

8

9

android:id="@+id/txt_header_title"

... />

android:id="@+id/btn_login"

... />

8. layout命名

組件類型_{范圍_}功能，范圍可選，只在有明確定義的范圍內才需要加上。

以下為幾種常用的組件類型命名：

activity_{范圍_}功能，為Activity的命名格式

fragment_{范圍_}功能，為Fragment的命名格式

dialog_{范圍_}功能，為Dialog的命名格式

item_list_{范圍_}功能，為ListView的item命名格式

item_grid_{范圍_}功能，為GridView的item命名格式

header_list_{范圍_}功能，為ListView的HeaderView命名格式

footer_list_{范圍_}功能，為ListView的FooterView命名格式

9. strings的命名

類型_{范圍_}功能，范圍可選。

以下為幾種常用的命名：

頁面標題，命名格式為：title_頁面

按鈕文字，命名格式為：btn_按鈕事件

標簽文字，命名格式為：label_標簽文字

選項卡文字，命名格式為：tab_選項卡文字

消息框文字，命名格式為：toast_消息

編輯框的提示文字，命名格式為：hint_提示信息

圖片的描述文字，命名格式為：desc_圖片文字

對話框的文字，命名格式為：dialog_文字

menu的item文字，命名格式為：action_文字

10. colors的命名

前綴{_控件}{_范圍}{_后綴}，控件、范圍、后綴可選，但控件和范圍至少要有一個。

背景顏色，添加bg前綴

文本顏色，添加text前綴

分割線顏色，添加div前綴

區分狀態時，默認狀態的顏色，添加normal后綴

區分狀態時，按下時的顏色，添加pressed后綴

區分狀態時，選中時的顏色，添加selected后綴

區分狀態時，不可用時的顏色，添加disable后綴

11. drawable的命名

前綴{_控件}{_范圍}{_后綴}，控件、范圍、后綴可選，但控件和范圍至少要有一個。

圖標類，添加ic前綴

背景類，添加bg前綴

分隔類，添加div前綴

默認類，添加def前綴

區分狀態時，默認狀態，添加normal后綴

區分狀態時，按下時的狀態，添加pressed后綴

區分狀態時，選中時的狀態，添加selected后綴

區分狀態時，不可用時的狀態，添加disable后綴

多種狀態的，添加selector后綴(一般為ListView的selector或按鈕的selector)

12. 動畫文件命名

動畫類型_動畫方向。

fade_in，淡入

fade_out，淡出

push_down_in，從下方推入

push_down_out，從下方推出

slide_in_from_top，從頭部滑動進入

zoom_enter，變形進入

三.注釋規范

1. 文件頭注釋

文件頂部統一添加版權聲明，聲明的格式如下：

1

2

3

/**

* Copyright (c) 2015. Keegan小鋼 Inc. All rights reserved.

*/

2. 類和接口注釋

類和接口統一添加javadoc注釋，格式如下：

1

2

3

4

5

6

/**

* 類或接口的描述信息

*

* @author ${USER}

* @date ${DATE}

*/

3. 方法注釋

下面幾種方法，都必須添加javadoc注釋，說明該方法的用途和參數說明，以及返回值的說明。

接口中定義的所有方法

抽象類中自定義的抽象方法

抽象父類的自定義公用方法

工具類的公用方法

1

2

3

4

5

6

7

8

9

10

/**

* 登錄

*

* @param loginName 登錄名

* @param password 密碼

* @param listener 回調監聽器

*/

publicvoidlogin(String loginName, String password,

ActionCallbackListener listener);

4. 變量和常量注釋

下面幾種情況下的常量和變量，都要添加注釋說明，優先采用右側//來注釋，若注釋說明太長則在上方添加注釋。

接口中定義的所有常量

公有類的公有常量

枚舉類定義的所有枚舉常量

實體類的所有屬性變量

1

2

3

4

5

6

7

8

publicstaticfinalintTYPE_CASH =1;// 現金券

publicstaticfinalintTYPE_DEBIT =2;// 抵扣券

publicstaticfinalintTYPE_DISCOUNT =3;// 折扣券

privateintid;// 券id

privateString name;// 券名稱

privateString introduce;// 券簡介

shrink_to_middle，中間縮小

來自:Android實戰開發

程序員共讀整理發布，轉載請聯系作者獲得授權返回搜狐，查看更多

責任編輯：

總結

以上是生活随笔為你收集整理的Android接口一般定义格式,Android开发规范的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。