Android 开发命名规范

一个好的开发规范,就是团队合作的基石

阿里巴巴Java开发手册(正式版)

Java 文件

采用驼峰命名法

文件头

具体设置可以查看我的另外一篇文章

/**
 * @author gmf (可以写固定的名称或者使用计算机用户名  ${USER})
 * @description 
 * @date ${DATE}.
 */

Activity

Activity 作为后缀,如:LoginActivity

Fragment

Fragment 作为后缀,如:UserFragment

Adapter

Adapter 作为后缀,如:CollectAdapter

常量

全部大写,单词之间用下划线分开,如:

private final String CACHE_PATH = "cache_path";

静态变量

首字母小写,加前缀s,如:

private static String sName;

成员变量

首字母小写,加前缀m,如:

private int mAge;

局部变量

首字母小写,不用加前缀,如:

int age;

控件变量

Android的控件变量,采用“逻辑功能+控件缩写”的形式,如:登陆按钮 loginBtn

常见的控件缩写对照表

组件名称 缩写
TextView Tv (tv)
ListView Lv (lv)
EditText Edt (edt)
CheckBox Chk (chk)
Button Btn (btn)
ImageButton Ibtn (ibtn)
ToggleButton Tbtn (tbtn)
RadioButton Rbtn (rbtn)
ImageView Iv (iv)
ProgressBar Pbar (pbar)
ScrollView Sclv (sclv)
LinearLayout Llyt (llyt)
RelativeLayout Rlyt (rlyt)
TableLayout Tlyt (tlyt)
FrameLayout Flyt (flyt)

这里有个小细节,变量声明一般这样,static 变量放在最前面,控件变量放中间,普通成员变量放在后面,示例如下:

// static 变量
private static final String PHOTO = "photo";

// 控件变量
private ImageView mPhotoIv;
private FloatingActionButton mEditFbtn;
private EditText mDescriptionEdt;
private EditText mAddressEdt;
private EditText mTimeEdt;
private EditText mCategoryEdt;

// 普通成员变量
private Photo mPhoto;

Android 资源文件

layout

1. 布局文件

格式:界面类型_模块.xml / 界面类型_模块_描述.xml

如:activity_login.xml, fragment_login.xml, dialog_login.xml

2. 列表项

格式:item_控件类型_功能描述 / item_控件类型_模块_功能描述

如:item_lv_order.xml, item_gv_main_photo.xml

3. 包含项

格式:包含类型_模块_描述 / 包含类型_控件类型_描述

如: merge_detail_footer.xml, include_refreshview_header.xml

4. 控件id

格式:模块名_控件类型_描述

activity_category.xml 文件下显示姓名的 TextView,其命名为 android:id="@+id/category_tv_name"

drawable

1. 静态图片

格式:
类型_common_描述:多个模块共用
类型_模块_描述:单个模块共用
类型_模块_描述_状态:配合动态风格使用

ic_common_delete.png (删除按钮,多个模块共用)
ic_accont_head.png(账户模块下的头像)
ic_theme_add_nomal.png (添加主题按钮的正常状态)
ic_theme_add_pressed.png (添加主题按钮的被按下状态)

2. 动态风格

格式:
common_描述:多个模块共用
模块_描述:单个某块共用

common_delete.xml (共用)
theme_add.xml (添加主题按钮)

string.xml

Java 文件和布局文件中,除了注释可以是中文,其他文字性说明都要放入 string.xml 中统一管理,它们在 string.xml 中的命名规范如下:

1. xml

格式:
控件id:控件有声明 id
模块_描述:控件无声明 id

<string name=”account_btn_login”>登录</string>
<string name=”account_forget_pwd”>忘记密码</string>

2. Java

格式:模块_描述

新闻详情页,用户点击收藏时提示「已收藏」:

ToastUtil.show(getString(R.string.detail_collected));

colors.xml

只定义颜色表,colors.xml文件中只是映射颜色的一个RGBA值,而没有其它的

糟糕的例子

<resources>
    <color name="listview_divider">#cfcfd2</color>
    <color name="listview_normal">#ffffff</color>
    <color name="listview_selected">#fafafa</color>
    <color name="actionbar_item_normal">#20699f</color>
    <color name="actionbar_item_selected">#105085</color>
</resources>

使用这种格式,你会非常容易的开始重复定义RGBA值,这使如果需要改变基本色变的很复杂。同时,这些定义是跟一些环境关联起来的,如 button, 应该放到一个按钮风格中,而不是在color.xml文件中。

好的例子

<resources>
    <!-- grayscale -->
    <color name="white">#FFFFFF</color>
    <color name="gray_light">#DBDBDB</color>
    <color name="gray">#939393</color>
    <color name="gray_dark" >#5F5F5F</color>

    <!-- basic colors -->
    <color name="green">#27D34D</color>
    <color name="blue">#2A91BD</color>
    <color name="orange">#FF9D2F</color>
    <color name="red">#FF432F</color>
</resources>

dimens.xml

像对待colors.xml一样对待dimens.xml文件,看个好的例子:

<resources>
    <!-- font sizes -->
    <dimen name="font_larger">22sp</dimen>
    <dimen name="font_large">18sp</dimen>
    <dimen name="font_normal">15sp</dimen>
    <dimen name="font_small">12sp</dimen>

    <!-- typical spacing between two views -->
    <dimen name="spacing_huge">40dp</dimen>
    <dimen name="spacing_large">24dp</dimen>
    <dimen name="spacing_normal">14dp</dimen>
    <dimen name="spacing_small">10dp</dimen>
    <dimen name="spacing_tiny">4dp</dimen>

    <!-- typical sizes of views -->
    <dimen name="button_height_tall">60dp</dimen>
    <dimen name="button_height_normal">40dp</dimen>
    <dimen name="button_height_short">32dp</dimen>
</resources>

style.xml

Android中,styles这个文件名称并没有作用,起作用的是在文件里xml的 <style>标签。因此你可以有多个style文件,如:

  • styles.xml
  • style_home.xml
  • styles_forms.xml
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • 还记得刚开始coding的时候,命名都是汉语拼音,所以有的时候想看懂它的意思,就要读一遍甚至好几遍才知道,这还是在...
    leo62阅读 8,829评论 2 19
  • 本文为 Crocutax 原创 , 转载请注明出处 http://www.crocutax.com 核心原则 见名...
    Crocutax阅读 2,455评论 0 5
  • 这里统一使用的命名规则作为开发组内进行沟通使用,约定俗成,仅供参考。 英文缩写原则 较短的单词可通过去掉"元音"形...
    kuwork阅读 4,139评论 0 20
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,395评论 25 707
  • 泛黄的纸张 写满狂妄的誓言 说要一起 牵手向前 撕裂的云朵 横亘在天 似我曾 许诺的永远 脚下无际的荒漠 你指着辽...
    我叫大象阅读 367评论 6 4