Android代码规范
Android代码规范
本文引用地址:https://www.eepw.com.cn/article/201609/304302.htm开始之前请详细阅读并遵守Android开发者代码风格指南
不要使用拼音命名
名称应简洁而富于描述,使用完整单词,避免使用缩写(除非该缩写被更广泛使用,例如URL、HTML)
代码中不要出现中文标点字符,例如:‘,’、‘:’
注释中可以书写中文标点字符,便于阅读
注释遵循英文写作习惯,英文标点符号后空一格,避免句子紧凑
颜色色值的字母必须全部大写
命名规则
1. 包命名
包名由小写的字母组成,默认以com.huashengrun.android.betterus开头,然后接上根据功能划分的模块名。
com.huashengrun.android.betterus.ui
com.huashengrun.android.betterus.ui.widget
2. 类和接口命名
名称的首字母需要大写,如果由多个单词组成,那么每个单词的首字母需要大写,其他字母小写。
class LoginActivity
interface OnClickListener
3. 方法的命名
采用驼峰命名法来命名。
public String getName()
public boolean isExist()
4. 变量的命名
采用驼峰命名法命名。
非公共的、非静态的域变量用m前缀
静态域变量用s前缀
集合类型的变量使用复数形式,若多种集合类型的变量存储的是相同类型的对象,除了根据功能区分,也可以简单通过集合类型来区分
public class User {
private int mId;
private static User sUser;
String mName;
protected int mAge;
public int level;
public List companies;
public List listScores;
public Score[] arrScores;
}
5. 常量的命名
常量需要声明为final static形式,组成名称的单词必须全部大写,单词之间用下划线隔开。
private static final int FADE_IN_TIME = 200;
6. 异常的命名
名称必须以Exception结尾。
NullPointerException
7. 布局的命名
name是模块的名称或功能的描述,单词必须全部小写,单词之间用下划线隔开。
类型 | 模板 | 事例 |
---|---|---|
Activity | activity_name.xml | activity_main.xml |
Tab | tab_name.xml | tab_home.xml |
Dialog | dialog_name.xml | dialog_login.xml |
ListItem | item_name.xml | item_contact.xml |
评论