Android编码规范

来源:互联网 发布:linux 创建文件 编辑:程序博客网 时间:2024/06/07 01:55
  1. 编码格式
    源代码的编码格式设置为UTF-8,防止乱码。UTF-8在编码效率和编码安全性上做了平衡,是一种理想的中文编码方式。编码比较详情请见深入分析Java中的中文编码问题。
  2. 命名规范
    无论什么的命名一定要做到见名知意,禁用拼音
    包名
    包名采用全小写,连续的单词只是简单地连接起来,不使用下划线。一般 采用反域名命名规则,全部使用小写字母。一级包名为 com,二级包名为 xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名
    为模块名或层级名。
    类名
    类名都以 UpperCamelCase 风格编写,尽可能避免缩写,除非一些约定 俗成的,像 HTML、URL 等。
    布局文件名
    布局文件的命名要与类名关联,采用小写,多个单词用下划线分开。如类名为 MainActivity,则布局文件的命名为 activity_main。
    资源文件的命名
    资源文件的命名全部小写,采用下划线命名法,加前缀区分。
    用途模块名逻辑名称
    用途模块名颜色
    用途_逻辑名称
    用途_颜色
    说明:用途也指控件类型
    例如: btn_main_home.png 按键
    divider_maket_white.png 分割线
    ic_edit.png 图标
    bg_main.png 背景
    变量名
    以 LowerCamelCase 风格命名 。
    常量名
    全部字母大写,用下划线分隔单词。
    方法名
    方法名都以 LowerCamelCase 风格编写。
    资源文件ID命名
    命名模式为:view 缩写_view 的逻辑名称。
  3. 注释的使用
    变量/常量:注明变量/常量的含义,一般采用单行注释。
    :建议注明类的使用场景,开发者标记(明确责任),一般采用文档注释。
    方法:注明方法的参数含义,返回值含义,一般采用文档注释。
    项目中的注释一定要注意,注释不仅仅可以帮助别人读懂你的代码,更方便自己日后查看自己的代码。
  4. 资源文件使用说明
    项目中用到的文字信息一定要统一到strings.xml文件中;项目中用到的颜色值定义在colors.xml文件中;项目中的距离大小dp、sp等定义到dimens.xml文件中。图片按照分辨率放到相应的drawable文件夹下,自定义的xml文件放到对应的文件夹下,例如自定义的颜色放到colors文件夹下;自定义的shape等放到drawable文件夹下,selector文件放到drawable文件夹下。
  5. 未完待续
0 0