阿里推荐 Android 命名规范
多人开发,需要长期维护的项目,尽量采用同一套命名规范原则。可以提高项目组间代码的互相阅读能力,节省后期维护成本。
阿里巴巴推荐使用的命名规范原则(模块名_资源名)
一.layout文件的命名方式:
Activity 的 layout 以 module_activity 开头
Fragment 的 layout 以 module_fragment 开头
Dialog 的 layout 以 module_dialog 开头
include 的 layout 以 module_include 开头
ListView 的行 layout 以 module_list_item 开头
RecyclerView 的 item layout 以 module_recycle_item 开头
GridView 的 item layout 以 module_grid_item 开头
二.drawable资源:
drawable 资源名称以小写单词+下划线的方式命名,根据分辨率不同存放在不同的 drawable 目录下, 如果介意包大小建议只使用一套, 系统去进行缩放。采用规则如下:
模块名_业务功能描述_控件描述_控件状态限定词
如:module_login_btn_pressed,module_tabs_icon_home_normal
三.anim资源:
anim 资源名称以小写单词+下划线的方式命名,采用以下规则:
模块名_逻辑名称_[方向|序号]
Tween 动画(使用简单图像变换的动画,例如缩放、平移)资源:尽可能以通用的动画名称命名。
如 module_fade_in , module_fade_out , module_push_down_in (动画+方向)。
Frame 动画(按帧顺序播放图像的动画)资源:尽可能以模块+功能命名+序号。
如module_loading_grey_001。
四.color资源:
color 资源使用#AARRGGBB 格式,写入 module_colors.xml 文件中,命名格式采用以下规则:
模块名_逻辑名称_颜色
如:<color name="module_btn_bg_color">#33b5e5e5</color>
五.dimen资源:
dimen 资源以小写单词+下划线方式命名,写入 module_dimens.xml 文件中,采用以下规则:
模块名_描述信息
如:<dimen name="module_horizontal_line_height">1dp</dimen>
六.dimen资源:
style 资源采用 “ 父 style 名称 . 当前 style 名称 ” 方式命名,写入module_styles.xml 文件中,首字母大写。如:
<style name="ParentTheme.ThisActivityTheme"></style>
七.String 资源:
string 资源文件或者文本用到字符需要全部写入 module_strings.xml 文件中,字符串以小写单词+下划线的方式命名,采用以下规则:
模块名_逻辑名称
如:moudule_login_tips,module_homepage_notice_desc
八.Id 资源:
Id 资源原则上以驼峰法命名,View 组件的资源 id 建议以 View 的缩写作为前缀。常用缩写表如下:
android 常用控件缩写表其它控件的缩写推荐使用小写字母并用下划线进行分割,例如:ProgressBar 对应的缩写为 progress_bar;DatePicker 对应的缩写为 date_picker。
九.图片资源:
图片根据其分辨率,放在不同屏幕密度的 drawable 目录下管理,否则可能
在低密度设备上导致内存占用增加,又可能在高密度设备上导致图片显示不够清晰。
说明:
为了支持多种屏幕尺寸和密度,Android 提供了多种通用屏幕密度来适配。常用的如下。
ldpi - 120dpi
mdpi - 160dpi
hdpi - 240dpi
xhdpi - 320dpi
xxhdpi - 480dpi
xxxhdpi - 640dpi
Android 的屏幕分辨率和密度并不存在严格的对应关系,应尽量避免直接基于分辨
率来开发,而是通过适配不同的屏幕密度来保证控件和图片的显示效果。不同密度
drawable 目录中的图片分辨率设置,参考不同密度的 dpi 比例关系。
正例:
为显示某个图标,将 48 x 48 的图标文件放在 drawable-mdpi 目录(160dpi)下;
将 72 x 72 的图标文件放在 drawable-hdpi 目录(240dpi)下;将 96 x 96 的图标
文件放在 drawable-xhdpi 目录(320dpi )下;将 144 x 144 的图标文件放在
drawable-xxhdpi 目录(480dpi)下。
反例:
上述图标,只有一个 144 x 144 的图标文件放在 drawable 目录下。