包命名规范
采用反域名命名规则,包名全部小写,连续的单词只是简单地连接起来,不使用下划线,一级包名为com,二级包名为xxx(可以是公司域名或者个人命名),三级包名根据应用进行命名,四级包名为模块名或层级名。如:
com.isa.crm.activity | com.isa.rm.adapter
JAVA类命名规范
采用大驼峰式命名法,尽量避免缩写,除非该缩写是众所周知的,比如HTML,URL,如果类名称包含单词缩写,则单词缩写的每个字母均应大写。如:
Product | ProductManager |
ProductListActivity | ProductListAdapter | JsonHTTPSRequest
接口命名规范
命名规则与类一样采用大驼峰命名法,多以able或ible结尾。如:
interface Runable | interface Accessible
回调用的接口以Listener结尾。如:
interface OnClickListener | interface OnCreateContextMenuListener
成员变量命名规范
采用小驼峰命名法,使用Google推荐命名方法。如:
private String mUserName;
常量命名
常量使用全大写字母加下划线的方式命名。如:
private static final int GROUP_ID_TOPIC_CARDS = 30;
private static final int GROUP_ID_THEME_CARDS = 40;
控件实例命名
采用小驼峰命名法,使用Google推荐命名方法,这会和布局文件中的控件id不一致。如:
在布局文件中 Button 的id为:
android:id="@+id/btn_pay"
private Button mPayButton;
方法命名规范
动词或动名词,采用小驼峰命名法。如:
run(); | onCreate(); | syncProducts();
布局文件(Layout)命名规范
全部小写,采用下划线命名法。其中{module_name}为业务模块或是功能模块等模块化的名称或简称。
这么写的话,会比较方便的在代码中使用,也比较方便在布局文件中查找。
activity layout: activity_{module_name}_{名称} ,如:
activity_home_shopping.xml
fragment layout: fragment_{module_name}_{名称} ,如:
fragment_home_shopping.xml
dialog layout: dialog_{module_name}_{名称} ,如:
dialog_home_loading.xml
包含项布局命名:include_{名称} ,如:
include_head.xml
adapter的子布局: item_{module_name}_{名称} ,如:
item_home_order.xml
widget layout: widget_{module_name}_{名称} ,如:
widget_home_shopping_detail.xml
资源id命名规范
命名模式为:{view缩写}_{module_name}_{view的逻辑名称},如:
首页实时用车模块布局 LinearLayout 的布局id –> ll_home_realtime
首页广告位的 ImageView 的布局id –> iv_home_banner
图片资源文件命名规范
这样写的话,会在代码中比较方便的关联出来,不需要记住图片的名字,只要打出ic就可以关联出一大堆,然后根据模块名过滤,就比较方便的定位出一个图片资源。要知道程序员的大脑是用来进行逻辑计算的,并不是用来存储工具可以帮助完成的事情的。
图标命名:ic_{module_name}_{名称} ,如:
ic_home_realtime.png
背景图片命名: bg_{module_name}_{名称} ,如:
bg_home_navbar.png
按钮Button命名: btn_{module_name}_{名称} ,如:
btn_home_login_normal.png
btn_home_login_pressed.png
btn_home_login_disabled.png
按钮checkbox图片命名:checkbox_{module_name}_{名称} ,如:
checkbox_home_agreement_normal.png
checkbox_home_agreement_selected.png
其他图片命名:{名称}_{module_name},如:
banner_home.png
代码风格
大括号问题:
if (hasMoney()) {
} else {
}
空格问题:
if else | while | 运算符两端 等后面需用空格隔开。例如:
if (hasMoney()) {
} else {
}
for (int i = 0; i < 10; i++) {
}
方法参数
当方法参数数量过多时(一屏能看完),需进行换行处理.
注释
必须要对所有实例变量、类常量进行注释说明,如
// 比较长的注释,就像这样的
private String userName // 短注释
必须对所有的类、接口进行注释说明,如:
/**
* Activity基类
*
*/
public class BaseActivity extends Activity
{
}
必须对所有的方法进行注释说明 父类的方法子类不需注释,接口的方法,实现类不需注释 ,如
/**
* 请求
*
* @param path 路径
* @param generalParams 基本参数
* @param businessParams 业务参数
* @return 请求结果
* @throws ApiException 请求错误则返回该异常
*/
public Map<String, Object> request (String path,
Map<String, Object> generalParams,
Map<String, Object> businessParams) throws ApiException {
return null;
}