Android之命名规范

俗话说”无规矩不成方圆“，各行各业都有自已不同的规则，软件开发，规则也是如此，下面就自己开发过程中的经验总结。

摘要

命名规则，尽量通俗易懂，使用英文命名，不要用中文的拼音命名，尽量加上注解

Java代码中不出现中文,最多注释中可以出现中文,便于后期国际化

一、包（packages）

全部使用小写字母。一级包名常见的有： com/cn/org/net，二级包名以公司或个人来命名，三级包名根据应用进行命名，四级包名为模块名或层级名。

例如：

com.caijicn.cjpadt

com.caijicn.cjpadt.adapter 

二、类（classes）

采用大驼峰命名法，所有单词的首字母大写。

采用 描述+类型命名

例如：

描述+Activity.java

LoginActivity.java

描述+Service.java

KeepAliveService.java

描述+Receiver.java

BootReceiver.java

描述+Adapter.java

GroupAddapter.java

描述+Utils.java

DateUtils.java 

三、接口（interface）

接口名称以 I 开头，如果有多个单词，每个单词首字母大写。

例如：

IAnswerChange 

四、事件监听器（event listener）

以On开头，如果有多个单词，每个单词首字母大写。 

例如：

OnClickListener

OnItemClickListener 

五、方法（methods）

小驼峰命名法，除首单词外，其余所有单词的首字母大写。 

例如：

initView 

六、参数（parameter）

小驼峰命名法 ，除首单词外，其余所有单词的首字母大写。 

例如：

page

pageSize 

七、变量（variables）

小驼峰命名法 ，除首单词外，其余所有单词的首字母大写。 

例如：

page

pageSize

8.1成员变量

成员变量以m为前缀 

例如

Context mContext;

TextView mTvVersion; 

8.2静态变量

静态变量以s为前缀

例如

private static String sMessage; 

8.3常量（constants）

全部大写,单词之间用下划线分割。 

例如：  

public static final int SPLASH_DURATION = 3000; 

8.4图片资源文件

前缀+模块+描述 

例如：

ic_main_search.png 

九、Layout命名

9.1 Activity contentview命名

activity_功能模块.xml

例如：

Activity_splash.xml

9.2 Fragment命名

fragment_功能模功.xml

例如：

fragment_class.xml

9.3 Dialog命名

dialog_描述.xml

例如：

dialog_evaluate.xml

dlg_evaluate.xml

9.4 include包含项

include_模块.xml 

例如：

include_head.xml

9.5列表项命名

listitem_描述.xml

例如：

listitem_grade.xml 

9.6 PopupWindow命名

ppw_描述.xml 

例如：

ppw_message_grade.xml 

9.7 View自定义命名

view_功能模块.xml   

例如:

view_search.xml 

十、布局文件ID命名

控件	缩写
ImageView	iv
TextView	tv
Button	btn
ImageButton	ib
CheckBox	cb
RadioButton	rb
DigtalClock	dc
DatePicker	dp
EditText	et
TimePicker	tp
ProgressBar	pb
SeekBar	sb
Tab	tab
Spinner	spi
ScrollView	sv
ListView	lv
ExpandableList	expL
LinearLayout	ll
FramLayout	fl
RelativeLayout	rl

  

十一、字符串命名

最好不要跟title、dialog、button等东西关系起来，直接用相同英文含义就可以了 

例如：

<string name="ok">确定</string>

<string name=" welcome_to_use">欢迎使用</string> 

十二、color.xml

通用的颜色色值放到color.xml文件中

<color name="common_statistics_text_color">#686868</color><!-- 统计文字颜色-->
<color name="common_statistics_selected_color">#8CC252</color><!--统计文字选中颜色-->

  

十三、注释

13.1 每个类名必须有注释,至少包含类描述,创建人,时间

例如：

/**
 * 类描述：选人Adapter
 * 创建人：Gent Liu
 * 创建时间：2016/8/8 16:17
 */
public class SelectionAdapter extends BaseAdapter {

 

13.2 每个方法名也需要加注释,至少包括方法描述,参数描述

例如：

/**
 * 打开Activity     *
 * @param context     上下文
 * @param packageName 包名
 * @param className   全类名
 */
public static void launchActivity(Context context, String packageName, String className) {

 

十四、APK打包命名

 应用发布apk版本命名规则：客户端名+版本号.apk

 例如：padt_ver0.91.apk;

转自http://www.iblogstreet.com/2017/02/13/android-name-convention.html