zoukankan      html  css  js  c++  java
  • Android 编码规范

    1.文件编码:UTF-8

    源文件编码格式为 UTF-8。

    2.数组初始化:可写成块状结构

    数组初始化可以写成块状结构,比如,下面的写法都是OK的:

    new int[] {
            0, 1, 2, 3 
    }
    new int[] {
            0,
            1,
            2,
            3
    }
    new int[] {
            0, 1,
            2, 3
    }
    new int[]
            {0, 1, 2, 3}
    

    3.Fall-through:注释

    在一个switch块内,每个语句组要么通过break, continue, return或抛出异常来终止,要么通过一条注释来说明程序将继续执行到下一个语句组, 任何能表达这个意思的注释都是OK的(典型的是用// fall through)。这个特殊的注释并不需要在最后一个语句组(一般是default)中出现。
    示例:
     1 switch (input) {
     2     case 1:
     3     case 2:
     4         prepareOneOrTwo();        // fall through
     5     case 3:
     6         handleOneTwoOrThree();
     7         break;
     8     default:
     9         handleLargeNumber(input);
    10 }

    4.标识符类型的规则

    4.1包名

    包名全部小写,连续的单词只是简单地连接起来,不使用下划线。
    采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。
    例如:com.jiashuangkuaizi.kitchen

    包名此包中包含
    com.xx.应用名称缩写.activity 页面用到的Activity类 (activitie层级名用户界面层)
    com.xx.应用名称缩写.base 基础共享的类
    com.xx.应用名称缩写.adapter 页面用到的Adapter类 (适配器的类)
    com.xx.应用名称缩写.util 此包中包含:公共工具方法类(util模块名)
    com.xx.应用名称缩写.bean 下面可分:vo、po、dto 此包中包含:JavaBean类
    com.xx.应用名称缩写.model 此包中包含:模型类
    com.xx.应用名称缩写.db 数据库操作类
    com.xx.应用名称缩写.view (或者 com.xx.应用名称缩写.widget ) 自定义的View类等
    com.xx.应用名称缩写.service Service服务
    com.xx.应用名称缩写.receiver BroadcastReceiver服务

    注意:
    如果项目采用MVP,所有M、V、P抽取出来的接口都放置在相应模块的i包下,所有的实现都放置在相应模块的impl下。

    4.2 类名

    类名都以UpperCamelCase风格编写。
    类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
    名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。

    描述例如
    Activity 类 Activity为后缀标识 欢迎页面类WelcomeActivity
    Adapter类 Adapter 为后缀标识 新闻详情适配器 NewDetailAdapter
    解析类 Parser为后缀标识 首页解析类HomePosterParser
    工具方法类 Util或Manager为后缀标识(与系统或第三方的Utils区分)或功能+Util 线程池管理类:ThreadPoolManager

    日志工具类:LogUtil(Logger也可)

    打印工具类:PrinterUtil

    数据库类 以DBHelper后缀标识 新闻数据库:NewDBHelper
    Service类 以Service为后缀标识 时间服务TimeServiceBroadcast
    Receiver类 以Receiver为后缀标识 推送接收JPushReceiver
    ContentProvider 以Provider为后缀标识  
    自定义的共享基础类 以Base开头 BaseActivity,BaseFragment

    测试类的命名以它要测试的类的名称开始,以Test结束。
    例如:HashTest 或 HashIntegrationTest。
    接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如
    interface Runnable ;
    interface Accessible。

    注意:
    如果项目采用MVP,所有Model、View、Presenter的接口都以I为前缀,不加后缀,其他的接口采用上述命名规则。

    4.3 方法名

    方法名都以 LowerCamelCase 风格编写。
    方法名通常是动词或动词短语。
     
    方法说明
    initXX() 初始化相关方法,使用init为前缀标识,如初始化布局initView()
    isXX() checkXX() 方法返回值为boolean型的请使用is或check为前缀标识
    getXX() 返回某个值的方法,使用get为前缀标识
    handleXX() 对数据进行处理的方法,尽量使用handle为前缀标识
    displayXX()/showXX() 弹出提示框和提示信息,使用display/show为前缀标识
    saveXX() 与保存数据相关的,使用save为前缀标识
    resetXX() 对数据重组的,使用reset前缀标识
    clearXX() 清除数据相关的
    removeXXX() 清除数据相关的
    drawXXX() 绘制数据或效果相关的,使用draw前缀标识
    下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是:test_,例如testPop_emptyStack。
    并不存在唯一正确的方式来命名测试方法。

    4.4 常量名

    常量名命名模式为CONSTANT_CASE,全部字母大写,用下划线分隔单词。那,到底什么算是一个常量?
    每个常量都是一个静态final字段,但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时,考虑它是否真的感觉像是一个常量。
    例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的,它要真的一直不变才能将它示为常量。

     1 // Constants
     2 static final int NUMBER = 5;
     3 static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann");
     4 static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable
     5 static final SomeMutableType[] EMPTY_ARRAY = {};
     6 enum SomeEnum { ENUM_CONSTANT }
     7 // Not constants
     8 static String nonFinal = "non-final";
     9 final String nonStatic = "non-static";
    10 static final SetmutableCollection = new HashSet();
    11 static final ImmutableSetmutableElements = ImmutableSet.of(mutable);
    12 static final Logger logger = Logger.getLogger(MyClass.getName());
    13 static final String[] nonEmptyArray = {"these", "can", "change"};

    这些名字通常是名词或名词短语。

    4.5 非常量字段名

    非常量字段名以LowerCamelCase风格的基础上改造为如下风格:
    基本结构为scopeVariableNameType,
    scope:范围
    非公有,非静态字段命名以m开头。
    静态字段命名以s开头。
    公有非静态字段命名以p开头。
    公有静态字段(全局变量)命名以g开头。
    public static final 字段(常量) 全部大写,并用下划线连起来。
    例子:

    1.  public class MyClass {  
    2.        public static final int SOME_CONSTANT = 42;  
    3.        public int pField;  
    4.        private static MyClass sSingleton;  
    5.        int mPackagePrivate;  
    6.        private int mPrivate;  
    7.        protected int mProtected; 
    8.        public static int gField; 
    9.  }

    使用1字符前缀来表示作用范围,1个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。

    4.6 资源文件命名规范

    1. 资源布局文件(XML文件(layout布局文件)):
    全部小写,采用下划线命名法
    1) contentview 命名
    必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。
    所有Activity或Fragment的contentView必须与其类名对应,对应规则为:
    将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。
    例如:activity_main.xml
    2) Dialog命名:dialog_描述.xml
    例如:dialog_hint.xml
    3) PopupWindow命名:ppw_描述.xml
    例如:ppw_info.xml
    4) 列表项命名:item_描述.xml
    例如:item_city.xml
    5) 包含项命名:模块_(位置)描述.xml
    例如:activity_main_head.xmlactivity_main_bottom.xml
    注意:通用的包含项命名采用:项目名称缩写_描述.xml
    例如:xxxx_title.xml
    2. 资源文件(图片drawable文件夹下):
    全部小写,采用下划线命名法,加前缀区分
    命名模式:可加后缀 _small 表示小图, _big 表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:
    用途_模块名_逻辑名称
    用途_模块名_颜色
    用途_逻辑名称
    用途_颜色
    说明:用途也指控件类型(具体见UI控件缩写表)
    例如:
    btn_main_home.png按键
    divider_maket_white.png 分割线
    ic_edit.png 图标
    bg_main.png 背景
    btn_red.png 红色按键
    btn_red_big.png 红色大按键
    ic_head_small.png 小头像
    bg_input.png输入框背景
    divider_white.png白色分割线
    如果有多种形态如按钮等除外如 btn_xx.xml(selector)

    名称功能
    btn_xx 按钮图片使用btn_整体效果(selector)
    btn_xx_normal 按钮图片使用btn_正常情况效果
    btn_xx_pressed 按钮图片使用btn_点击时候效果
    btn_xx_focused state_focused聚焦效果
    btn_xx_disabled state_enabled (false)不可用效果
    btn_xx_checked state_checked选中效果
    btn_xx_selected state_selected选中效果
    btn_xx_hovered state_hovered悬停效果
    btn_xx_checkable state_checkable可选效果
    btn_xx_activated state_activated激活的
    btn_xx_windowfocused state_window_focused
    bg_head 背景图片使用bg_功能_说明
    def_search_cell 默认图片使用def_功能_说明
    ic_more_help 图标图片使用ic_功能_说明
    seg_list_line 具有分隔特征的图片使用seg_功能_说明
    sel_ok 选择图标使用sel_功能_说明


    注意:
    使用AndroidStudio的插件SelectorChapek可以快速生成selector,前提是命名要规范。
    3. 动画文件(anim文件夹下):
    全部小写,采用下划线命名法,加前缀区分。
    具体动画采用以下规则:
    模块名_逻辑名称
    逻辑名称
    refresh_progress.xml
    market_cart_add.xml
    market_cart_remove.xml
    普通的tween动画采用如下表格中的命名方式
    // 前面为动画的类型,后面为方向


    动画命名例子规范写法
    fade_in 淡入
    fade_out 淡出
    push_down_in 从下方推入
    push_down_out 从下方推出
    push_left 推向左方
    slide_in_from_top 从头部滑动进入
    zoom_enter 变形进入
    slide_in 滑动进入
    shrink_to_middle 中间缩小

    4.7 values中name命名

    类别命名示例
    strings strings的name命名使用下划线命名法,采用以下规则:

    模块名+逻辑名称

    main_menu_about 主菜单按键文字

    friend_title好友模块标题栏

    friend_dialog_del好友删除提示

    login_check_email登录验证

    dialog_title 弹出框标题

    button_ok确认键 loading加载文字

    colors colors的name命名使用下划线命名法,采用以下规则:

    模块名+逻辑名称 颜色

    friend_info_bgfriend_bg transparent gray
    styles styles的name命名使用Camel命名法,采用以下规则:模块名+逻辑名称 main_tabBottom

    4.8 UI控件缩写表

    控件缩写例子
    LinearLayout ll llFriend或者mFriendLL
    RelativeLayout rl rlMessage或mMessageRL
    FrameLayout fl flCart或mCartFL
    TableLayout tl tlTab或mTabTL
    Button btn btnHome或mHomeBtn
    ImageButton ibtn btnPlay或mPlayIBtn
    TextView tv tvName或mNameTV
    EditText et etName或mNameET
    ListView lv lvCart或mCartLV
    ImageView iv ivHead或mHeadIV
    GridView gv gvPhoto或mPhotoGV

    表2 常见的英文单词缩写:

    名称缩写
    icon ic (主要用在app的图标)
    color cl(主要用于颜色值)
    divider di(主要用于分隔线,不仅包括Listview中的divider,还包括普通布局中的线)
    selector sl(主要用于某一view多种状态,不仅包括Listview中的selector,还包括按钮的selector)
    average avg
    background bg(主要用于布局和子布局的背景)
    buffer buf
    control ctrl
    delete del
    document doc
    error err
    escape esc
    increment inc
    infomation info
    initial init
    image img
    Internationalization I18N
    length len
    library lib
    message msg
    password pwd
    position pos
    server srv
    string str
    temp tmp
    window wnd(win)

    程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。



    作者:diygreen
    链接:http://www.jianshu.com/p/0a984f999592
    來源:简书

      

  • 相关阅读:
    【DUBBO】dubbo架构详解(转载)
    【数据库】sql连表查询
    第十三章 三种非对称加密算法总结
    第十二章 非对称加密算法-RSA
    第十一章 非对称加密算法--DH
    第十章 五种对称加密算法总结
    第九章 对称加密算法--IDEA
    第八章 对称加密算法--AES
    第七章 对称加密算法--DES
    第六章 三大消息摘要算法总结
  • 原文地址:https://www.cnblogs.com/lixiangyang521/p/7573714.html
Copyright © 2011-2022 走看看