免费虚拟机安卓版,优化大师下载安装app,长春做网络优化的公司,选服务好的网站建设公司一. AndroidStudio开发工具规范
使用最新的稳定版本.统一文件的编码格式为utf-8. 清除每个类里面的无效的import导包.代码样式统一,比如#xff0c;tab缩进4个空格#xff0c;或者 tab size等如果没有特殊情况使用默认的配置即可。每行字数每行字符数不得超过 160 字符…一. AndroidStudio开发工具规范
使用最新的稳定版本.统一文件的编码格式为utf-8. 清除每个类里面的无效的import导包.代码样式统一,比如tab缩进4个空格或者 tab size等如果没有特殊情况使用默认的配置即可。每行字数每行字符数不得超过 160 字符设置 Editor - Code Style. 编辑完 .java、.kt、.xml 等文件后必须格式化.
二. 命名规范
1. 包名
包名全部小写不允许出现中文、大写字母或者下划线。
2. 类名
类名采用大驼峰命名法用名词或名词词组命名每个单词的首字母大写。尽量避免缩写除非该缩写是众所周知的 比如 HTML、URL如果类名称中包含单词缩写则单词缩写的每个字母均应大写。
类描述例如Activity类模块名 Activity闪屏页类SplashActivityFragment类模块名 Fragment主页类HomeFragmentService类模块名 Service时间服务TimeServiceBroadcastReceiver类功能名 Receiver推送接收JPushReceiverContentProvider类功能名 ProviderShareProvider自定义 View功能名 View/ViewGroup(组件名称)ShapeButtonDialog对话框功能名DialogImagePickerDialogAdapter类模块名 Adapter课程详情适配器LessonDetailAdapter解析类功能名 Parser首页解析类HomePosterParser工具方法类功能名 Utils或Manager线程池管理类ThreadPoolManager日志工具类LogUtilsLogger也可打印工具类PrinterUtils数据库类功能名 DBHelper新闻数据库NewsDBHelper自定义的共享基础类Base 基础BaseActivity,BaseFragment抽象类Base/Abstract开头AbstractLogin异常类Exception结尾LoginException
接口interface命名规则与类一样采用大驼峰命名法。
3. 方法名
方法名都以 lowerCamelCase 风格编写。方法名通常是动词或动词短语。
方法说明initXX()初始化相关方法使用 init 为前缀标识如初始化布局initView()isXX(),checkXX()方法返回值为 boolean 型的请使用 is/check 为前缀标识getXX()返回某个值的方法使用 get 为前缀标识setXX()设置某个属性值handleXX(),processXX()对数据进行处理的方法displayXX(),showXX()弹出提示框和提示信息使用 display/show 为前缀标识updateXX()更新数据saveXX(),insertXX()保存或插入数据resetXX()重置数据clearXX()清除数据removeXX(),deleteXX()移除数据或者视图等如removeView()drawXX()绘制数据或效果相关的使用 draw 前缀标识
4. 变量命名
这里的变量为广义的变量包括了常量、局部变量、全局变量等它们的基础规则是
类型需要是名词 / 名词短语采用 lowerCamelCase 风格
在具体的变量命名时会根据该变量的类型不同而附加额外的命名规则
类型说明例如常量大写 下划线隔开Kotlin 一定要 const valconst val TYPE_NORMAL 1 static final TYPE_NORMAL 1临时变量名整型i、j、k、m、n字符型一般用c、d、efor(int i 0;i len; i)其他变量lowerCamelCase风格即可私有变量也不要使用m开头private int tmp;Kotlin只读变量使用val可变变量使用var尽可能使用valvar tmp 0 val defaultIndex 0
5. 资源文件
资源文件命名为全部小写采用下划线命名法。
动画资源文件anim/ 和 animator/
安卓主要包含属性动画和视图动画其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/ 目录下视图动画文件需放在 res/anim/ 目录下。命名规则{模块名_}逻辑名称。 说明{} 中的内容为可选逻辑名称 可由多个单词加下划线组成。例如refresh_progress.xml、market_cart_add.xml、market_cart_remove.xml。 如果是普通的补间动画或者属性动画可采用动画类型_方向 的命名方式。
例如
名称说明fade_in淡入fade_out淡出push_down_in从下方推入push_down_out从下方推出push_left推向左方slide_in_from_top从头部滑动进入zoom_enter变形进入slide_in滑动进入shrink_to_middle中间缩小
图片资源文件drawable/ 和 mipmap/
res/drawable/ 目录下放的是位图文件.png、.9.png、.jpg、.gif或编译为可绘制对象资源子类型的 XML 文件而 res/mipmap/ 目录下放的是不同密度的启动图标所以 res/mipmap/ 只用于存放启动图标其余图片资源文件都应该放到 res/drawable/ 目录下。
命名规则类型{_模块名}_逻辑名称、类型{_模块名}_颜色。 说明{} 中的内容为可选类型 可以是可绘制对象资源类型也可以是控件类型最后可加后缀 _small 表示小图_big 表示大图。 例如
名称说明btn_main_about.png主页关于按键类型_模块名_逻辑名称btn_back.png返回按键类型_逻辑名称divider_maket_white.png商城白色分割线类型_模块名_颜色ic_edit.png编辑图标类型_逻辑名称bg_main.png主页背景类型_逻辑名称btn_red.png红色按键类型_颜色btn_red_big.png红色大按键类型_颜色ic_avatar_small.png小头像图标类型_逻辑名称bg_input.png输入框背景类型_逻辑名称divider_white.png白色分割线类型_颜色bg_main_head.png主页头部背景类型_模块名_逻辑名称def_search_cell.png搜索页面默认单元图片类型_模块名_逻辑名称ic_more_help.png更多帮助图标类型_逻辑名称divider_list_line.png列表分割线类型_逻辑名称sel_search_ok.xml搜索界面确认选择器类型_模块名_逻辑名称shape_music_ring.xml音乐界面环形形状类型_模块名_逻辑名称
如果有多种形态如按钮选择器sel_btn_xx.xml采用如下命名
名称说明sel_btn_xx作用在btn_xx上的selectorbtn_xx_normal默认状态效果btn_xx_pressedstate_pressed点击效果btn_xx_focusedstate_focused聚焦效果btn_xx_disabledstate_enabled不可用效果btn_xx_checkedstate_checked选中效果btn_xx_selectedstate_selected选中效果btn_xx_hoveredstate_hovered悬停效果btn_xx_checkablestate_checkable可选效果btn_xx_activatedstate_activated激活效果btn_xx_window_focusedstate_window_focused窗口聚焦效果 注意使用 Android Studio 的插件 SelectorChapek 可以快速生成 selector前提是命名要规范。 布局资源文件layout/
命名规则类型_模块名、{模块名_}类型_逻辑名称。(也采用 PBF方便查看尤其在大项目中) 说明{} 中的内容为可选。 例如
类型名称说明Activitymain_activity.xml主窗体模块名_类型Fragmentmusic_fragment.xml音乐片段模块名_类型Dialogloading_dialog.xml加载对话框逻辑名称_类型PopupWindowinfo_ppw.xml信息弹窗PopupWindow逻辑名称_类型adapter的列表项main_song_item.xml主页歌曲列表项模块名_类型_逻辑名称
布局资源 id 命名
命名规则view 缩写{_模块名}_逻辑名例如 btn_main_search、btn_back。 注意:使用databinding,viewbinding 直接获取布局文件控件的时候id 命名采用驼峰样式。
菜单资源文件menu/
菜单相关的资源文件应放在该目录下。命名规则{模块名_}逻辑名称 说明{} 中的内容为可选。 字符串资源文件strings
string 的 name 命名使用下划线命名法采用以下规则{模块名_}逻辑名称这样方便同一个界面的所有 string 都放到一起方便查找。
名称说明main_menu_about主菜单按键文字friend_title好友模块标题栏friend_dialog_del好友删除提示login_check_email登录验证dialog_title弹出框标题button_ok确认键loading加载文字
样式资源文件tyles
style 的 name 命名使用大驼峰命名法几乎每个项目都需要适当的使用 styles.xml 文件因为对于一个视图来说有一个重复的外观是很常见的将所有的外观细节属性colors、padding、font放在 styles.xml 文件中。在应用中对于大多数文本内容最起码你应该有一个通用的 styles.xml 文件例如
style nameContentTextitem nameandroid:textSizedimen/font_normal/itemitem nameandroid:textColorcolor/basic_black/item
/style应用到 TextView 中
TextViewandroid:layout_widthwrap_contentandroid:layout_heightwrap_contentandroid:textstring/pricestylestyle/ContentText/或许你需要为按钮控件做同样的事情将一组相关的和重复 android:xxxx 的属性放到一个通用的
颜色资源文件color/
color/ 是专门用于存放颜色相关资源的文件夹。命名规则类型{_模块名}_逻辑名称。 说明{} 中的内容为可选。例如sel_btn_font.xml。 color 的 name 命名使用下划线命名法在你的 colors.xml 文件中应该只是映射颜色的名称一个 ARGB 值而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。 ?xml version1.0 encodingutf-8? !-- grayscale --color namewhite #FFFFFF/colorcolor namegray_light#DBDBDB/colorcolor namegray #939393/colorcolor namegray_dark #5F5F5F/colorcolor nameblack #323232/color!-- basic colors --color namegreen#27D34D/colorcolor nameblue#2A91BD/colorcolor nameorange#FF9D2F/colorcolor namered#FF432F/color向应用设计者那里要这个调色板名称不需要跟 green、blue 等等相同。brand_primary、brand_secondary、brand_negative 这样的名字也是完全可以接受的。像这样规范的颜色很容易修改或重构会使应用一共使用了多少种不同的颜色变得非常清晰。通常一个具有审美价值的 UI 来说减少使用颜色的种类是非常重要的。
注意如果某些颜色和主题有关那就单独写一个 colors_theme.xml。
注释规范
4.1 类注释
每个类完成后应该有作者姓名和联系方式的注释对自己的代码负责。
/*** Author xxx* Date xxxx/xx/xx* Email xxxxxxxxx.com* Desc 欢迎界面*/
public class WelcomeActivity {...
}具体可以在 AS 中自己配制进入 Settings - Editor - File and Code Templates - Includes - File Header输入
/*** Author : ${USER}* Date : ${YEAR}/${MONTH}/${DAY}* Email : xxxxx* Desc :*/这样便可在每次新建类的时候自动加上该头注释。
4.2 方法注释
每一个成员方法包括自定义成员方法、覆盖方法、属性方法的方法头都必须做方法头注释在方法前一行输入 /** 回车 或者设置 Fix doc commentSettings - Keymap - Fix doc comment快捷键AS 便会帮你生成模板我们只需要补全参数即可。
4.3 块注释
块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */ 风格也可以是 // ... 风格 // 后最好带一个空格 。对于多行的 /* ... */ 注释后续行必须从 * 开始 并且与前一行的 * 对齐。
4.4 全局变量的注释
全局变量的注释样式如下注意注释之间有空格
/*** The next available accessibility id.*/
private static int nextAccessibilityViewId;
/*** The animation currently associated with this view.*/
protected Animation currentAnimation null;4.5 其他一些注释
AS 已帮你集成了一些注释模板我们只需要直接使用即可在代码中输入 TODO、FIXME 等这些注释模板回车后便会出现如下注释。
// TODO: 17/3/14 需要实现但目前还未实现的功能的说明
// FIXME: 17/3/14 需要修正甚至代码是错误的不能工作需要修复的说明4.5 注释必须遵守的规范
提测的代码不应该有 TODO 这样的注释(特殊情况除外)
