Android 开发基本规范
2016-06-22 15:29
405 查看
书写规范
1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了。
2. 缩进统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进。另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。
3. 花括号不要单独一行,和它前面的代码同一行。而且,花括号与前面的代码之间用一个空格隔开。
[代码]java代码:
?4. 空格的使用
if、else、for、switch、while等逻辑关键字与后面的语句留一个空格隔开。[代码]java代码:
?[代码]java代码:
?[代码]java代码:
?5. 空行的使用
将逻辑相关的代码段用空行隔开,以提高可读性。空行也只空一行,不要空多行。在以下情况需用一个空行:两个方法之间
方法内的两个逻辑段之间
方法内的局部变量和方法的第一条逻辑语句之间
常量和变量之间
6. 当一个表达式无法容纳在一行内时,可换行显示,另起的新行用8个空格缩进。
[代码]java代码:
?7. 一行声明一个变量,不要一行声明多个变量,这样有利于写注释。
[代码]java代码:
?8. 行宽设置为100,设置格式化时自动断行到行宽位置。
9. 使用快捷键进行代码自动格式化。
Windows:CTRL+ALT+LMac:OPTION+COMMAND+L
10. 一个方法最多不要超过40行代码。
11. 范围型的常量用枚举类定义,而不要直接用整型或字符,这样可以减少范围值的有效性检查。
[代码]java代码:
?12. 文字大小的单位统一用sp,元素大小的单位统一用dp。
13. 应用中的字符串统一在strings.xml中定义,然后在代码和布局文件中引用。
14. 颜色值统一在colors.xml中定义,然后在代码和布局文件中引用。另外,不要在代码和布局文件中引用系统的颜色,除了透明。
命名规范
1. 包命名
域名反写+项目名称+模块名称,全部单词用小写字母。例如,我的KAndroid项目的Model模块包名如下:
[代码]java代码:
?2. 类和接口命名
使用大驼峰规则,用名词或名词词组命名,每个单词的首字母大写。以下为几种常用类的命名:
activity类,命名以Activity为后缀,如:LoginActivity
fragment类,命名以Fragment为后缀,如:ShareDialogFragment
service类,命名以Service为后缀,如:DownloadService
adapter类,命名以Adapter为后缀,如:CouponListAdapter
工具类,命名以Util为后缀,如:EncryptUtil
模型类,命名以BO为后缀,如:CouponBO
接口实现类,命名以Impl为后缀,如:ApiImpl
3. 方法命名
使用小驼峰规则,用动词命名,第一个单词的首字母小写,其他单词的首字母大写。以下为几种常用方法的命名:
初始化方法,命名以init开头,例:initView
按钮点击方法,命名以to开头,例:toLogin
设置方法,命名以set开头,例:setData
具有返回值的获取方法,命名以get开头,例:getData
通过异步加载数据的方法,命名以load开头,例:loadData
布尔型的判断方法,命名以is或has,或具有逻辑意义的单词如equals,例:isEmpty
4. 控件缩写
控件 | 缩写 | 控件 | 缩写 |
---|---|---|---|
TextView | txt | EditText | edt |
Button | btn | ImageButton | ibtn |
ImageView | img | ListView | list |
RadioGroup | group | RadioButton | rbtn |
ProgressBar | progress | SeekBar | seek |
CheckBox | chk | Spinner | spinner |
TableLayout | table | TableRow | row |
LinearLayout | llayout | RelativeLayout | rlayout |
ScrollView | scroll | SearchView | search |
TabHost | host | TabWidget | widget |
5. 常量命名
全部为大写单词,单词之间用下划线分开。[代码]java代码:
?6. 变量命名
{范围描述+}意义描述+类型描述的组合,用驼峰式,首字母小写。[代码]java代码:
?7. 控件id命名
控件缩写_{范围_}意义,范围可选,只在有明确定义的范围内才需要加上。[代码]xml代码:
?8. layout命名
组件类型_{范围_}功能,范围可选,只在有明确定义的范围内才需要加上。以下为几种常用的组件类型命名:
activity_{范围_}功能,为Activity的命名格式
fragment_{范围_}功能,为Fragment的命名格式
dialog_{范围_}功能,为Dialog的命名格式
item_list_{范围_}功能,为ListView的item命名格式
item_grid_{范围_}功能,为GridView的item命名格式
header_list_{范围_}功能,为ListView的HeaderView命名格式
footer_list_{范围_}功能,为ListView的FooterView命名格式
9. strings的命名
类型_{范围_}功能,范围可选。以下为几种常用的命名:
页面标题,命名格式为:title_页面
按钮文字,命名格式为:btn_按钮事件
标签文字,命名格式为:label_标签文字
选项卡文字,命名格式为:tab_选项卡文字
消息框文字,命名格式为:toast_消息
编辑框的提示文字,命名格式为:hint_提示信息
图片的描述文字,命名格式为:desc_图片文字
对话框的文字,命名格式为:dialog_文字
menu的item文字,命名格式为:action_文字
10. colors的命名
前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。背景颜色,添加bg前缀
文本颜色,添加text前缀
分割线颜色,添加div前缀
区分状态时,默认状态的颜色,添加normal后缀
区分状态时,按下时的颜色,添加pressed后缀
区分状态时,选中时的颜色,添加selected后缀
区分状态时,不可用时的颜色,添加disable后缀
11. drawable的命名
前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。图标类,添加ic前缀
背景类,添加bg前缀
分隔类,添加div前缀
默认类,添加def前缀
区分状态时,默认状态,添加normal后缀
区分状态时,按下时的状态,添加pressed后缀
区分状态时,选中时的状态,添加selected后缀
区分状态时,不可用时的状态,添加disable后缀
多种状态的,添加selector后缀(一般为ListView的selector或按钮的selector)
12. 动画文件命名
动画类型_动画方向。fade_in,淡入
fade_out,淡出
push_down_in,从下方推入
push_down_out,从下方推出
slide_in_from_top,从头部滑动进入
zoom_enter,变形进入
shrink_to_middle,中间缩小
注释规范
1. 文件头注释
文件顶部统一添加版权声明,声明的格式如下:[代码]java代码:
?2. 类和接口注释
类和接口统一添加javadoc注释,格式如下:[代码]java代码:
?3. 方法注释
下面几种方法,都必须添加javadoc注释,说明该方法的用途和参数说明,以及返回值的说明。接口中定义的所有方法
抽象类中自定义的抽象方法
抽象父类的自定义公用方法
工具类的公用方法
[代码]java代码:
?4. 变量和常量注释
下面几种情况下的常量和变量,都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释。接口中定义的所有常量
公有类的公有常量
枚举类定义的所有枚举常量
实体类的所有属性变量
[代码]java代码:
?相关文章推荐
- ASP编码必备的8条原则
- XML指南——XML编码
- C#中字符串编码处理
- ExtJS中文乱码之GBK格式编码解决方案及代码
- 程序员趣味读物 谈谈Unicode编码
- 文本文件编码方式区别
- C语言安全编码之数值中的sizeof操作符
- C#实现获取文本文件的编码的一个类(区分GB2312和UTF8)
- VC中BASE64编码和解码使用详解
- 计算机中的字符串编码、乱码、BOM等问题详解
- Base64编码解码原理及C#编程实例
- C#编码好习惯小结
- javascript编码的几个方法详细介绍
- UTF8编码开发中页面空白问题的解决方法
- php生成固定长度纯数字编码的方法
- 重新restore了mysql到另一台机器上后mysql 编码问题报错
- c# Base64编码和图片的互相转换代码
- java自动根据文件内容的编码来读取避免乱码
- PHP写入WRITE编码为UTF8的文件的实现代码
- 设置php页面编码的两种方法示例介绍