安卓命名规范

女爷i 2021-09-26 03:42 296阅读 0赞

**命名规范：**

1 包（packages）: 采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名  
![这里写图片描述][SouthEast]  
2 类（classes）：名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。  
![这里写图片描述][SouthEast 1]  
3 接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如interface Runna ble ;  
interface Accessible 。  
4 方法（methods）：动词或动名词，采用小驼峰命名法例如:onCreate(),run()  
![这里写图片描述][SouthEast 2]  
5 变量（variables）采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。

用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。  
量词列表：量词后缀说明  
First 一组变量中的第一个  
Last 一组变量中的最后一个  
Next 一组变量中的下一个变量  
Prev 一组变量中的上一个  
Cur 一组变量中的当前变量

6 常量（Constants）全部大写,采用下划线命名法.例如：MIN\_WIDTH  
7 资源文件（图片drawable文件夹下）：全部小写，采用下划线命名法，加前缀区分  
命名模式：activity名称*逻辑名称/common*逻辑名称  
如果有多种形态如按钮等除外如btn\_xx.xml（selector）  
![这里写图片描述][SouthEast 3]  
命名后缀：  
![这里写图片描述][SouthEast 4]  
8 资源布局文件（XML文件（layout布局文件））：  
全部小写，采用下划线命名法  
1)．contentview命名, Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀：  
功能模块.xml  
例如：main.xml、more.xml、settings.xml  
或则：activity\_功能模块.xml  
例如：activity\_main.xml、activity\_more.xml  
2)．Dialog命名：dialog\_描述.xml  
例如：dlg\_hint.xml  
2)．PopupWindow命名：ppw\_描述.xml  
例如：ppw \_info.xml  
3). 列表项命名listitem\_描述.xml  
例如：listitem\_city.xml  
4)．包含项：include\_模块.xml  
例如：include\_head.xml、include\_bottom.xml  
5)．adapter的子布局：功能模块\_item.xml  
例如：main\_item.xml、

9 动画文件（anim文件夹下）：全部小写，采用下划线命名法，加前缀区分。

//前面为动画的类型，后面为方向  
![这里写图片描述][SouthEast 5]  
10 资源ID（resourcesid）：大小写规范与方法名一致，采用小驼峰命名法。命名规范为“资源控件的缩写 名”+“变量名”。注意：页面控件名称应该和控件id名保持一致  
strings.xml，colors.xml等中的id命名：  
命名模式：activity名称*功能模块名称*逻辑名称/activity名称*逻辑名称/common*逻辑名称  
strings.xml中，使用activity名称注释，将文件内容区分开来

11 layout中的id命名  
命名模式为：view缩写\_模块名称\_view的逻辑名称  
view的缩写详情如下：  
![这里写图片描述][SouthEast 6]  
![这里写图片描述][SouthEast 7]  
12.activity中的view变量命名  
命名模式为：逻辑名称+view缩写  
建议：如果layout文件很复杂，建议将layout分成多个模块，每个模块定义一个moduleViewHolder，其成员变量包含所属view  
13.styles.xml：将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中；  
14.使用layer-list和selector

**Android编码规范建议（别人弄的觉得蛮有道理）**  
1.Java代码中不出现中文，最多注释中可以出现中文  
2.局部变量命名、静态成员变量命名  
只能包含字母，单词首字母除第一个外，都为大写，其他字母都为小写  
3.常量命名  
只能包含字母和*，字母全部大写，单词之间用*隔开  
4.图片尽量分拆成多个可重用的图片  
5.服务端可以实现的，就不要放在客户端  
6.引用第三方库要慎重，避免应用大容量的第三方库，导致客户端包非常大  
7.处理应用全局异常和错误，将错误以邮件的形式发送给服务端  
8.图片的.9处理  
9.使用静态变量方式实现界面间共享要慎重  
10.Log(系统名称模块名称接口名称，详细描述)  
11.单元测试（逻辑测试、界面测试）  
12.不要重用父类的handler，对应一个类的handler也不应该让其子类用到，否则会导致message.what冲突  
13.activity中在一个View.OnClickListener中处理所有的逻辑  
14.strings.xml中使用%1$s实现字符串的通配  
15.如果多个Activity中包含共同的UI处理，那么可以提炼一个CommonActivity，把通用部分叫由它来处理，其他activity只要继承它即可  
16.使用button+activitgroup实现tab效果时，使用Button.setSelected(true)，确保按钮处于选择状态，并使activitygroup的当前activity与该button对应  
17.如果所开发的为通用组件，为避免冲突，将drawable/layout/menu/values目录下的文件名增加前缀  
18.数据一定要效验，例如  
字符型转数字型，如果转换失败一定要有缺省值；  
服务端响应数据是否有效判断  
转载自：[http://blog.csdn.net/meryvn/article/details/48969393][http_blog.csdn.net_meryvn_article_details_48969393]

[SouthEast]: /images/20210923/33e59206eb4b48fe97939c46f64b675d.png
[SouthEast 1]: /images/20210923/b0b955d5a36047fe8bac01e9c36c06d6.png
[SouthEast 2]: /images/20210923/93289f2d357b47768605c2d11c1a1bc2.png
[SouthEast 3]: /images/20210923/b90a6194ee92460fa15b26dc3b4bb3a3.png
[SouthEast 4]: /images/20210923/0a5179b3d91d43f396f3ac8f9e2f298c.png
[SouthEast 5]: /images/20210923/4d29cad7d9c84aaea8699260b2a071d1.png
[SouthEast 6]: /images/20210923/3480efae3e05485d89435eba2c999809.png
[SouthEast 7]: /images/20210923/e2f5340694d840f2b145776bd6d946ac.png
[http_blog.csdn.net_meryvn_article_details_48969393]: http://blog.csdn.net/meryvn/article/details/48969393