Android代码书写规范

来源:互联网 发布:如何恢复手机软件数据 编辑:程序博客网 时间:2024/06/10 06:09

类的命名

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

方法的命名

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

package命名

  • 全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。

接口的命名

  • 命名规则与类一样采用大驼峰命名法,多以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中尽量不出现中文
- 服务端可以实现的,就不要放在客户端
- 引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大

0 0