最近一个团队中帮别人做一个Android项目。因为考虑到代码之间需要互通,所以记录下Android项目的命名规则,以此作为标准。
首先要注意两点:
1、命名的同时需要中文注释,才能更好地帮助其他人理解你的代码。
2、Android项目中除了注释和文字资源,不应该再出现中文。
命名规则分为以下几类:
1、资源布局文件(layout文件夹中,xml文件)
全部小写,采用下划线命名法
(1)contentview命名,Activity默认布局:activity_功能模块.xml
例如:activity_main.xml,activity_more.xml
(2)Dialog命名:dlg_描述.xml
例如:dlg_hint.xml
(3)PopupWindow命名:ppw_描述.xml
例如:ppw_info.xml
(4)列表项命名:listitem_描述.xml
例如:listitem_city.xml
(5)包含项命名:include_模块.xml
例如:include_head.xml,include_bottom.xml
(6)adapter的子布局:功能模块_item.xml
例如:main_item.xml
2、layout中的id命名
view缩写_view的逻辑名称(考虑要不要加上所在空间)
例如:登录按钮:btn_logon
附上view的缩写:
3、类文件
功能模块Activity.class(大驼峰命名)
例如:LoginActivity.class
里面的方法,变量用小驼峰命名法;常量全部大写+"_"
4、资源文件
(1)图片
1)静态图片
前缀_模块 或 前缀_模块_描述
例如:bg_MainActivity_search.png
以下是
2)动态图片
静态图片命名_后缀
例如:btn_back_nor.png,btn_back_press.png
(2)字符串
直接用相同英文含义就可以了
例如:<string name="welcome_to_use">欢迎使用</string>
不同XML中的字符串用不同的strings.xml(或在strings.xml中加上注释)
(3)样式文件
Activity名称_style.xml