代码技术与规范
这个作业属于哪个课程 | 2018级计算机和综合实验班 |
---|---|
这个作业要求在哪里 | 作业要求 |
这个作业的目标 | 进行Alpha冲刺 |
一、顺序规范
单文件顺序
1、常量
2、枚举类
3、类
View(Activity、Fragment)内部顺序
1、常量
2、Public属性、Private属性、构造函数
3、生命周期方法(onCreate、onResume)
4、UI方法(initView, resetView)
5、UI事件(onXXX)
6、网络请求
7、网络响应回调
8、通知响应回调
ViewModel内部顺序
1、Public LiveData - 外部监听
2、Private MutableLiveData - 内部持有
3、网络事件方法
4、其他事件方法
Model编写规范
1、注解@Parceblize + data class + : Parceble
2、或data class: Serializable (因使用的是反射,执行效率不如第一种)
3、XXXModelBuilder(通过构造模式将接口Json模型转换为页面需要的UI模型,反之亦然)
二、注释规范
注释,即一段说明代码,并不会被编译器执行,在Java语言中有三种方式:
1、 //,单行注释
2、 /.../,多行注释
3、 /**...*/,文档注释,用这种方式可以生成java doc文档,所以也叫java doc注释
三、命名规范
包括类名、接口名,枚举名,自定义注解名、方法名、变量名,常量名等。按照Java语言的一些命名规范以及参考系统源码的一些命名规范,主要是采用驼峰命名法。
1、类、接口、自定义注解、枚举,首字母大写后面第二个单词首字母,如:IntentService、FragmentActivity这种系统提供的类。
2、常量,即使用static final修饰,全部大写,由多个单词组合而成,并且每个单词之间用_(下划线)隔开,如:Toast类的LENGTH_SHORT和LENGTH_LONG。
3、静态变量,即使用static修饰,命名跟成员变量一样,如:static int totalNumber
4、布局变量,即在方法中定义的变量,命名跟成员变量一样,如:
public static int getScore() {
int age = 22;
Log.d("tag", "getScore: " + age);
return score;
}
5、文件夹:小写activity,fragment,viewholder,viewmodel,model,net,extension
6、类名:首字母大写+驼峰+身份结尾(xxxActivity,xxxModel,xxxExtension)
编码格式统一为UTF-8