Android代码书写规范

作者: Anwfly | 来源:发表于2019-05-15 21:41 被阅读7次
  • package命名: 全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。

  • 类的命名:大驼峰的命名法,如:MainActivity

  • 方法的命名:小驼峰的命名法,如:startActivity。

  • 接口的命名: 命名规则与类一样采用大驼峰命名法,多以able或ible结尾。

  • 变量的命名:采用小驼峰命名法。
    注意:作用统一的变量,在结尾加一个量词进行区分更容易搜索和记忆,如strNameFirst和strNameLast

  • 常量的命名:常量全部大写,如:MIN MAX

  • 布局文件的命名:布局文件使用“前缀_逻辑名”的方式,单词全部小写:
    ①activity的布局——activity_xxx
    ②fragment的布局——fragment_xxx
    ③自定义控件的布局——view_xxx
    ④对话框的布局——dialog_xxx
    ⑤列表项的布局——item_xxx

  • 资源文件的命名:资源文件使用“模块名_逻辑名”方式,单词全部小写:
    ①按钮以btn为前缀,如果是图片可以是btn_login.png,按钮的点击形态可以是btn_login_normal.xml以及btn_login_pressed.xml
    ②图片的命名以iv为前缀,例如iv_share.png
    ③背景图片可以用bg作为前缀。

  • 注释的规范:

Javadoc 常见的标记
@param 参数的说明
@return 返回值的说明
@throws 异常的描述
@version 模块的版本号
@author 模块作者
@see 参考转向
@deprecated 标记是否过时
  • 其他编码规范:除了以上的规范,其他比较重要的注意点,总结如下:
    ①java中尽量不出现中文
    ②服务端可以实现的,就不要放在客户端
    ③引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大

相关文章

  • Android代码书写规范

    1、一个顶级类(只有一个) 2、使用图片类要显式回收 3、数据库和cursor要显式close 4、对象的引用在不...

  • Android代码书写规范

    标识符命名法 标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的...

  • Android代码书写规范

    package命名: 全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据...

  • Android代码的书写规范

    毕业工作也有几年了,从开始学习写代码的时候就没有养成好的代码习惯,野路子起家,但是随着工作的深入,越发感觉,代码的...

  • Android编码规范

    Android开发代码规范相关系列文章: Android命名规范 Android编码规范 Android编码规范有...

  • 代码书写规范

    HTML是描述网页结构的超文本标记语言,HTML规范能够使HTML代码风格保持一致,使得HTML更容易理解和维护。...

  • 书写代码规范

    通过分析github代码库总结出来的工程师代码书写习惯 使用英文小写 别忘记结束符 嵌套注意层层缩进标签,缩进使用...

  • 代码书写规范

    res命名规范: src中命名规范: 习惯命名:

  • 代码书写规范

    声明: 为了便于浏览,本文章所用的代码是简化后的结果 适当的注释 注释是非常重要的。注释可以帮助你或者你的同事亦或...

  • Android命名规范

    Android开发代码规范相关系列文章: Android命名规范 Android编码规范 俗话说:无规矩不成方圆,...

网友评论

    本文标题:Android代码书写规范

    本文链接:https://www.haomeiwen.com/subject/olqvaqtx.html