Android代码规范精华版

部分参考自:https://hawstein.com/2014/01/20/google-java-style/ 以及Android源码

必须遵守

  1. 宏定义:使用static final修饰,名字全大写
private static final int PICK_IMAGE_REQUEST_CODE = 100;
  1. 常量写在类的最前面,变量写在常量后面
  2. 日志打印规范
  • 格式:前缀使用应用名加下划线,Sdk使用应用名加Sdk名加下划线,TAG使用类名;
比如日历应用:Calendar_CalendarApplication
  • 有异常或提前返回时打印,正常逻辑一般不打,视情况而定
ActivityManager am = (ActivityManager) getSystemService(Context.ACTIVITY_SERVICE);
if (am == null) {
    LogUtil.e(TAG, "terrible, am is null!");
    return;
}
        try {
                  ......
        } catch (Exception e) {
            //e.printStackTrace();  禁止使用
            LogUtil.e(TAG, "something is exception : " + e.toString());
        }
  1. 重写父类接口:加上@Override, 方便理解
  2. 判断语句执行的代码块,必须加上{},即使只有一行,包括if、while、switch...case等
boolean find = false;
if(state) {
    find = true;
}
  1. switch...case语句必须加上default操作
switch(state) {
     case state0: {
        break;
    }
    default : {
        break;
    }
}
  1. 内部类放在类的最后面,接口放在变量后面,构造方法前面
  2. 实现了父类接口的变量放在一般变量后面,函数前面
    private EditText mEditText;
    private Handler mHandler = new Handler(Looper.getMainLooper()) {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                default:{
                    break;
                }
            }
        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }
  1. 每次只声明一个变量
  2. 类名或接口通常是名词或名词短语,第一个字母大写
  3. 方法名通常是动词或动词短语,第一个字母小写
  4. 参数名:参数应该避免用单个字符命名
  5. 字符串的连接:超过两个字符串的连接,使用StringBuilder或StringBuffer(同步)

强烈建议遵守

  1. 尽量使用正向判断,而不是负向判断,因为正向更容易理解
                //不建议这样做
                if (!TextUtils.isEmpty(path)) {
                    mMediaPlayer.prepareAsync();
                } else {
                    mMediaPlayer.reset();
                }
                
                //建议这样做
                if (TextUtils.isEmpty(path)) {
                    mMediaPlayer.reset();
                } else {
                    mMediaPlayer.prepareAsync();
                }
  1. 避免使用静态变量
  2. 代码格式化使用Android Studio默认即可
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,835评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,900评论 2 383
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,481评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,303评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,375评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,729评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,877评论 3 404
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,633评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,088评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,443评论 2 326
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,563评论 1 339
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,251评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,827评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,712评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,943评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,240评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,435评论 2 348