Android 编程规范

前言

通过建立代码编写规范,形成Android编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。

软件编码要遵循以下原则:

  1. 遵循开发流程,在产品和设计的指导下进行代码编写。
  2. 代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。
  3. 程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。
  4. 程序可读性强,易于理解;方便调试和测试,可测试性好。
  5. 易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。
  6. 占用资源少,以低代价完成任务。
  7. 在不降低程序的可读性的情况下,尽量提高代码的执行效率。

一. 命名规范

不要使用汉语拼音简写。用准确的英文

  • 包名
    采用反域名命名规则,<font color = "#ff0000">全部使用小写字母。</font>一级包名为com,二级包名为xxx(可以是公司域名或者个人命名),三级包名根据应用进行命名,四级包名为模块名或层级名。
  • 类名&接口名
    采用<font color = "#ff0000">大驼峰</font>命名法,尽量避免缩写,除非该缩写是众所周知的,比如HTML,URL,如果类名称包含单词缩写,则单词缩写的每个字母均应大写。
  • 方法名
    动词或动名词,采用<font color = "#ff0000">小驼峰</font>命名法,eg:onCreate(),run();
  • (常量) static final字段
    字母全部大写,单词间以下划线分割
  • 全局/全局变量名
    有两套标准 java(xXXXX) google(mXXXX).我们采用java的标准,<font color = "#ff0000">小驼峰</font>命名法
  • 布局文件名
    contentview命名 功能模块.xml.
    adapter的子布局:功能模块_item.xml
    ...
  • 资源文件名
    除通用的资源外,保持和功能模块一致,自定义的shape等以*.shape.xml
  • 布局文件中view的id名。控件简写变量名,textview tv button bt_(或者btn_) LinearLayout ll_ 等。举例如下:
 <TextView
     android:id="@+id/tv_handed"
     android:layout_width="wrap_content"
     android:layout_height="wrap_content" />

二. 代码规范

  1. 统一 code style

    采用androidstudio默认即可,检查下不同系统下是否一致
  2. 编码方式 "UTF-8"
  3. 使用TODO注释
对那些临时性的、短期的、够棒但不完美的代码,请使用TODO注释。
TODO注释应该包含全部大写的TODO,后跟一个冒号:
// TODO: Remove this code after the UrlTable2 has been checked in.
和
// TODO: Change this to use a flag instead of a constant.
如果TODO注释是“将来要做某事”的格式,则请确保包含一个很明确的日期(“在2005年11月会修正”),或是一个很明确的事件(“在所有代码整合人员理解了V7协议之后删除本段代码”)。
  1. 先写注释再写代码

三. 布局规范

  1. 单位使用规范
    控件长宽采用dp作为统一的衡量单位,字体使用sp作为统一衡量单位。
  2. 切图命名规范
    具体命名规范,请看《Android切图规范及命名规则》文档。
  3. 资源文件夹res下的规范
    在res资源目录下,应该至少包含下面的目录结构
    其中,各个版本的drawable中存放的内容如下
    Ø drawable 存放使用xml文件实现的各种selector按下效果
    Ø drawable-hdpi 存放480800,480854像素的图片
    Ø drawable-ldpi 存放240320像素的图片,现在基本废弃
    Ø drawable-mdpi 存放320
    480像素的图片,现在基本废弃
    Ø drawable-xhdpi 存放720*1280像素及以上的图片
    Ø drawable-xxhdpi 暂时只放144px的图标

四. 参考

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,451评论 25 707
  • 命名规范 1. 基本原则 (1) 代码风格与android源码保持一致(2) 命名要清晰明了、有明确含义(3) ...
    Brian512阅读 573评论 0 5
  • 参考资料:我总结的Android编程规范 1. 命名规则 1.1 类名,接口名: 以大写开头,如果一个类的类名由多...
    Coder_Y阅读 2,785评论 12 60
  • 架构&分包 -- 原则 包名应让人一目知意:英文命名描述其功能。 分包层次应尽可能的低,减短包名长度。 Model...
    zhazhaxin阅读 1,734评论 3 48
  • 综合练习前面三天所学的一丢丢内容img、href、table、frameset,加以巩固。框架html: 顶部按钮...
    zhanglizzy阅读 662评论 1 0