写在开头
“无规矩不成方圆”,开发中同样需要遵守规范。
我始终相信,评价一个程序员好坏,最直接的方法就是看他的代码规范,代码质量上去了,你的水平提高了,自然而然收益也就提高了。
所以从现在开始请养成良好的习惯吧。
女程序
驼峰命名法
驼峰命名法就是当变量名或函式名是由一个或多个单词连结在一起,而构成的唯一识别字时,第一个单词以小写字母开始;第二个单词的首字母大写或每一个单词的首字母都采用大写字母。
譬如:
myFirstName、myLastName,
这样的变量名看上去就像骆驼峰一样此起彼伏,故得名。驼峰命名法的命名规则可视为一种惯例,并无绝对与强制,为的是增加识别和可读性。
小驼峰法
变量一般用小驼峰法标识。驼峰法的意思是:除第一个单词之外,其他单词首字母大写。
譬如
int myPhoneCount;
变量myPhoneCount第一个单词是全部小写,后面的单词首字母大写。
大驼峰法
相比小驼峰法,大驼峰法(即帕斯卡命名法)把第一个单词的首字母也大写了。常用于类名,函数名,属性,命名空间。
譬如:
public class MyUser;
实际开发中
介绍完概念的东西,我开始分享我实际开发中常用的命名规范,以供参考。
1、包的命名规范
包名一律小写
建议采用如下规则:【com】.【公司名/组织名】.【项目名称】.【模块名】
譬如:
com.zxl.demo
然后就可以在这个目录下根据逻辑分层。
2、类的命名规范
Android中类的命名与JAVA开发采用一致的规范即可。
大驼峰命名法,即所有单词首字母大写。
譬如:
MainActivity、UserBean
3、方法的命名规范
与java开发类似,采用驼峰命名规则。
首单词首字母小写,其余单词首字母大写。尽量不要使用下划线。
譬如:
getUserInfo()、onCreate()
4、变量的命名规范
采用驼峰命名规则
java普通变量:
譬如:
userInfo、userName
Android控件变量
我个人比较喜欢【控件缩写】+【控件逻辑名称】的方式。
譬如:
btnLogin、etPass
5、常量命名规范
全部采用大写书写,每个单词之间用_隔开。
譬如:
public static final String BASE_URL = “https://www.baidu.com/”;
6、Layout命名规范(其他资源命名类似,比如:mipmap下的图片资源)
全部采用小写,单词之间用下划线分隔
譬如:
activity_main、fragment_home、icon_home_normal.png
图片命名推荐:
静态图片前缀模块、前缀模块_描述
icon_main_bg.png、ic_main_search.png
动态图片前缀模块描述状态、前缀描述_状态
btn_login_normal.png、btn_login_press.png
Xml中id的命名,建议直接根据意义命名。
制定好了规范,就要遵守,有了统一的规范,项目才好维护,相互之间才好review代码。