一、命名规范
1.类文件命名规范(
大驼峰规则
)
1)每个单词首字母大写。如MyStudentCount;
2)且为名词;
3)对于工具类:使用Util结尾
2.方法命名规范(
小驼峰规则
)
1)除第一个单词之外,每个单词首字母大写。如getColor;
2)第一个单词且为动词;
3.Id命名规范(
对应view的前缀 控件 Id命名缩写前缀
)
Button -------------------btn
ImageView --------------iv
EditText------------------et
TextView ---------------tv
LinearLayout------------ll
RealtiveLayout---------rl
WebView--------------- web
ImageButton-----------imgBtn
RadioButton----------- radio
CheckBox-------------- cb
FrameLayout---------- fl
TableLayout----------- tab
ScrollView--------------scroll
4.变量命名
规范
1):
普通变量,满足小驼峰规则
2):静态变量:全部大写,多个单词则以 _ 分开, 比如BOOLEAN_FLAG
3):跟控件相关的变量:添加前缀,并满足小驼峰规则:tvPhone
4):
常量:全部大写,采用下划线命名法. 例如:MIN_WIDTH
5.图片命名规范(
功能从最大到最小,最范到最具体
)
前缀缩写:bg: 背景
ic:小图标
如 bg_banner_weather
bg_banner_message
6.资源文件夹中资源命名规范
1)资源文件全为小写
2)相应文件前添加相应的前缀
3)在前缀后添加相应的功能
4)用_分隔多个功能,功能范围从大到小
1:对于全局使用(唯一性)的资源命名:line_blue
2:按钮点击事件选择器:selector 用下划线分割功能,前面的颜色值为默认颜色,后面的颜色值为按下时的颜色。 如:selector_white_black selector_round_rect_white_black
3: 形状文件:(oval/rect/round_rect)
4: 图片文件:(ic/bg)_
5: 动画文件 淡入 fade_in
淡出 fade_out
从下方推入 push_down_in
从下方推出 push_down_out
推像左方 push_left
从头部滑动进入 slide_in_from_top
变形进入 zoom_enter
滑动进入 slide_in
中间缩小 shrink_to_middle
6: 布局文件: Activity对应视图: activity
fragment对应视图: fragment
include加载的视图:layout
其他控件对应视图: layout
分割线视图: divider_
功能比较具体的视图可添加功能缩写为前缀:如对话框:dialog_
注释规范
1:类开头注释: /* 需要别的地方可以看到 */
2:方法前注释: /* 需要别的地方可以看到 */
3:块注释: /因为别的地方不会看到 */
4:执行步骤或者变量注释: // 并将此注释添加在备注释部分的后端,而不是上端
如:private int name; //名字
5:静态变量使用: /** 这个注释是这个意思 / 放在变量上方
6:一段代码逻辑的注释,保持一行 /这段是干嘛用的*/
7:添加TODO规范 必要的地方需要添加TODO,不需要的TODO及时删除。
引用第三方sdk所需要的appid和app secret统一集中在stringappid.xml下 命名规则:appId+名称。 如:appIdqq appSecret+名称。如appSecret_qq
其他
未完,持续更新中...