代码格式,注意事项

命名规则

  • 包名必须以com开头,后面跟有项目名称(或者缩写),再后面为模块名或层级名称;

  • 类名,接口名,方法名,变量名,必须使用驼峰规则,尽量选用通用词汇;

  • 常量的命名,应该全部大写,单词间用下划线隔开。

  • layout xml 的命名必须以 全部单词小写,单词间以下划线分割:

    Activity 的 layout 以 activity 开头
    Fragment 的 layout 以 fragment 开头
    Dialog 的 layout 以 dialog 开头
    include 的 layout 以 include 开头
    ListView 的行 layout 以 list_item 开头
    RecyclerView 的 item layout 以 recycle_item 开头
    GridView 的行 layout 以 grid_item 开头
    如果是在特定项目中,需要在前面加上module的标示。如alibaba_activity。

  • id的命名,小写+下划线。结尾以控件缩写。如:title_tv,poster_iv。

  • 资源的命名,同样是单词小写+下划线。
    所有的命名注意避免拼写错误。

注释规范

  • 类注释:
    模板设置:Android Studio -> File -> Settings -> 左上角搜索 File and Code Templates -> 右边面板选择Class
/**
 * Author ${USER} 
 * Date ${DATE}
 * Desc 
 */

desc加上这个类的简短描述,让人一目了然。

  • 方法注释
    不要求所有方法都添加注释,但容易产生歧义或功能不清的方法需添加文档注释。
    需要对参数和返回值进行说明的,需要使用:
/**
     * 
     * @param keyCode
     * @param event
     * @return
     */
  • 类成员变量和常量注释
    类成员变量和常量, 通常情况注释写在声明的上方。

  • 其他注释
    方法内部的注释多行 使用/*…… */形式,如果为单行是用//……形式的注释;部分自定义的枚举,数字标识一定要加上注释;另外接口中的方法必须加上文档注释。

规约

  • 方法
    一个方法尽量不要超过15行,如果方法太长,说明当前方法业务逻辑已经非常复杂,那么就需要进行方法拆分,保证每个方法只作一件事。
    不要使用 try catch 处理业务逻辑。
  • 参数和返回值
    一个方法的参数尽可能的不要超过4个!
    如果一个方法返回的是一个错误码,请使用异常!!
    尽可能不要使用null, 替代为异常 或者使用空变量 如返回 List 则可以使用Collections.emptyList()
  • 神秘的数
    代码中不允许出现单独的数字,字符!如果需要使用数字或字符,则将它们按照含义封装为静态常量!(for语句中除外)
    -- 控制语句
    判断中如有常量,则应将常量置于判断式的右侧。如:
if ( true == isAdmin()){
    //...
}

if中多条件的情况,抽出来用变量定义,不要把多个判断全部放在if中
多个if else的情况,最后的else要加上,避免单边。

  • 异常的捕捉处理
    通常的思想是只对错误采用异常处理:逻辑和编程错误,设置错误,被破坏的数据,资源耗尽,等等。
    通常的法则是系统在正常状态下以及无重载和硬件失效状态下,不应产生任何异常。
    最小化从一个给定的抽象类中导出的异常的个数。对于经常发生的可预计事件不要采用异常。不要使用异常实现控制结构。
    若有finally 子句,则不要在try 块中直接返回,亦不要在finally 中直接返回。

  • 访问控制
    若没有足够理由,不要把实例或类变量声明为公有。通常,实例变量无需显式的设置(set)和获取(gotten),通常这作为方法调用的边缘效应 (side effect)而产生。
    一个具有公有实例变量的恰当例子,是类仅作为数据结构,没有行为。亦即,若你要使用一个结构(struct)而非一个类(如果java 支持结构的话),那么把类的实例变量声明为公有是合适的。

  • 资源引用
    layout和code中不要使用hard code资源值,资源值定义在dimens,colors和integers等资源文件中,被外部引用。
    控件尽量使用style来定义组合样式,利用style的继承关系,复用资源。

  • 内部类的使用(避免内存泄漏)
    可以用内部类, 不过用的时候,内部类需要是静态的,如果用到外层类的context,需要使用弱引用。
    如果内部类跟外部类生命周期是同步的,则不需要考虑内存泄漏问题。所以主要是异步的内部类或者匿名内部类造成内存泄漏。
    如果可以,尽量少用内部类的形式

  • TODO只是临时使用的提示方式,加上相应的代码后及时删除

  • 代码中警告的部分,尽量避免。如出现黄色警告部分,无论是注释中的,还是代码中,都尽量去除,增强代码健壮性。

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

推荐阅读更多精彩内容

  • 一、Java 简介 Java是由Sun Microsystems公司于1995年5月推出的Java面向对象程序设计...
    子非鱼_t_阅读 4,154评论 1 44
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,587评论 18 399
  • 在这里,希望喜欢它的人一起每日感悟人生哲理,为你的生活多一点改变。 1、与怪物战斗的人,应当小心自己,不要成为怪物...
    林窗鲸落阅读 201评论 0 0
  • 活着是为了什么? 复仇么, 是我毁了塔丽乡。 变强么, 最强也不会有什么意义。 找到那个人么, 然后呢, 没有然后...
    第七诗人阅读 166评论 0 0
  • 二十九岁,我最后一个以“二”开头的年华。时间一直在流逝,我没想过会这么快。我就这样不可逃避地踉踉跄跄地奔向我不...
    爱逗子阅读 636评论 13 6