Android 你不可不看的命名規範

標籤：classes   自訂   save   mtab   推出   hone   anim   table   fragment   

 標識符命名法最要有四種:

• Camel(駱駝)命名法：除首單詞外，其餘所有單詞的第一個字母大寫，如：fooBar;
• Pascal命名法:所有單詞的第一個字母大寫，如：FooBar；
• 底線命名法:單詞與單詞間用底線做間隔，如：foo_bar;
• 匈牙利命名法:廣泛應用於微軟編程環境中，在以Pascal命名法的變數，首字母小寫說明該變數的類型。 量的取名方式為：scope_ prefix_qualifier 範圍首碼，類型首碼，限定詞,如:g_foo_bar;

安卓App層開發主要是Java語言，所以基本使用除了匈牙利命名法外的命名方式；

縮寫在命名是必須的，遵循下面規則：

• 較短的單詞可通過去掉“母音”形成縮寫,如icon->ic;
• 較長的單詞可取單詞的頭幾個字母形成縮寫,如：average->avg;
• 此外還有一些約定成俗的英文單詞縮寫,如 Internationalization->I18N;
• 程式中不要用縮寫，除非該縮寫是約定俗成的。

命名規範：

• 包（packages）: 採用反網域名稱命名規則，全部使用小寫字母。一級包名為地頂級網域名稱如com，二級包名為xx（可以是公司或則個人的隨便），三級包名根據應用進行命名，四級包名為模組名或層級名; 如 com.tinyx.myapp.activities;
• 類（classes）：用Pascal命名法，盡量避免縮寫，如：MyActivity；縮寫是眾所周知的，如HTML,URL；類名稱中包含單詞縮寫，則單詞縮寫的每個字母均應大寫，如：PublicHTML，CommonURL。
• 介面（interface）：與類一樣用Pascal命名法，多以able或ible結尾，多用作表示行為，如Runnable，Accessible；

• 方法（methods）：動詞或動名詞，採用Camel命名法，如：onCreate(),run()；下面是一些建議：

  • 初始化相關方法，使用init為首碼標識，如：初始化布局initView()；
  • boolean型使用is或check為首碼標識, 如：checkValue()、isValidate();
  • 返回某個值的方法，使用get為首碼標識，如：getName();
  • 資料進行處理相關，盡量使用process為首碼標識，如：processUpdate();
  • 儲存資料相關，使用save為首碼標識，如：saveData();
  • 對資料重設的，使用reset首碼標識，如：resetData();
  • 清除資料相關，使用clear首碼標識，如：clearData();
  • 移除某些項目，使用remove首碼標識，如:removeItem();
  • 繪製資料或效果相關的，使用draw首碼標識，如：drawCircle();
• 變數（variables）：採用Pascal命名法，建議採用有意義的命名如：firstName,lastName;　模型類變數預設以上規則

public class User {    public String name;    public String phone;    public int sex; //1，男 2，女   public User() {         this.name = "myname";        this.phone = "123“        this.sex = 0;    }}

• 非模型類全域參數建議加上小寫m開頭；

public class TestActivity extends Activity{    private ZoomableImageView mZoomableView;    private TabLayout mTabLayout;    private int mItemsCount;   @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.test_activity);    }}

常量（constants）: 全部大寫,採用底線命名法.如下：

public static final int MAX_ITEMS= 10;public static final String TAG = User.class.getSimpleName();

 資源檔命名（resources）：採用底線命名法,全部小寫,針對不同資源，建議用下面的命名方法；

• drawable資源，加首碼命名：首碼_功能_模組_說明.xml/png/

說明	命名範例
表徵圖：建議格式 ic_xxx；	ic_appicon.png
背景：建議格式 bg_xxx；	bg_normal_button_default.xml,bg_normal_button_press.xml

 

• layout 資源檔，首碼命名：類型_模組_功能_說明.xml,舉一些常用的例子如下：

說明	命名範例
Activity布局檔案	activity_main.xml
Fragment布局檔案	fragment_main.xml
局部布局View檔案	view_main_header.xml,view_main_bottom.xml
自訂提示對話方塊	dialog_alert.xml
清單項目等	fragment_user_list_item.xml

• 動畫anim資源檔（anim只有一種資源，所以不必加首碼區分）：模組_功能_動畫_方向.xml

說明	命名範例
淡入	main_button_fade_in.xml
淡出	main_button_fade_out.xml
從下方推入	button_push_down_in.xml
從下方推出	main_button_push_down_out.xml

• menu菜單資源檔（menu只有一種資源，所以不必加首碼區分），模組_功能_說明.xml

說明	命名範例
主介面菜單	main_activity.xml
Fragment介面菜單	user_fragment.xml

• values資源，這個主要分下面幾種資源：

1、 ids資源，主要存放是介面控制項的id值，用底線小寫命名法，首碼方式：首碼_模組_功能_說明,常用介面控制項命名如下：

說明	命名範例
布局和子控制項(ViewGroup，自訂View)	view_main_topnav
TextView	tv_main_title
Button	btn_user_add
ImageButton	imgbtn_user_del
ImageView	img_thumb
CheckBox	cb_sex
RadioButton	rbtn_answer
EditText	et_username
ToggleButton	toggle_funtion
ProgressBar	pb_download
SeekBar	sb_progress
ProgressBar	pb_download
VideoView	vv_course
WebView	wv_download
RantingBar	rb_download
Spinner	sp_cities
ScollView	sv_main
TextSwitch	sp_cities
ListView/ExpandListView/RecyclerView	lv_cities
MapView	mv_location

2、strings/arrays/dimens資源，用底線小寫命名法，不加任何前尾碼，格式，模組_功能_說明

3、attrs/colors/ids的屬性和名稱使用 Camel命名法; styles的屬性使用Camel命名法，名稱使用Pascal命名法；如下面：

<!--attrs--><attr name="text" format="string" /><attr name="itemIcon" format="reference" /><attr name="showToggle" format="boolean" /><attr name="showVersion" format="boolean" /><style name="Theme.AppCompat.Light.NoActionBar">        <item name="windowActionBar">false</item>        <item name="windowNoTitle">true</item></style> <!--colors--> <color name="colorPrimary">#009688</color> <color name="colorPrimaryDark">#00796b</color> <color name="colorAccent">#cddc39</color> <!--ids--> <item name="tabLayout" type="id"/> <item name="viewPager" type="id"/> <item name="viewContainer" type="id"/>

有問題歡迎留言，寫信([email protected])或者關注我的公眾號：

Android 你不可不看的命名規範