代码技术规范

Posted 2021-06-12 RuanGongShiJian_18

这个作业属于哪个课程	2018级计算机和综合实验班
这个作业要求在哪里	作业要求
这个作业的目标	进行Beta冲刺

一、顺序规范

1.1单文件顺序

1、常量
2、枚举类
3、类

1.2View(Activity、Fragment)内部顺序

1、常量
2、Public属性、Private属性、构造函数
3、生命周期方法(onCreate、onResume)
4、UI方法(initView, resetView)
5、UI事件(onXXX)
6、网络请求
7、网络响应回调
8、通知响应回调

1.3ViewModel内部顺序

1、Public LiveData - 外部监听
2、Private MutableLiveData - 内部持有
3、网络事件方法
4、其他事件方法

1.4Model编写规范

1、注解@Parceblize + data class + : Parceble
2、或data class: Serializable (因使用的是反射,执行效率不如第一种)
3、XXXModelBuilder(通过构造模式将接口Json模型转换为页面需要的UI模型，反之亦然)

二、代码编写规范

2.1XML内容编写规范

1.节点要彼此嵌套，不能跨节点。
2.节点的属性不得重复。
3.XML标签的属性值必须用“""”包含起来
4.注释的格式问题
5.XML声明必须出现在文档的第一行
6.XML的标签内的属性严格区分大小写，也就是和是两个不同的标签

2.2Java代码规范

2.3命名规范

1. 名字含义要明确，做到见名知义,如: User，Customer
2. 尽量少用缩写，必须确保能让人看懂含义。

2.4变量名

1. 小驼峰式命名，变量名首字母必须为小写字母，不使用 “_” 作为变量名(包括成员变量)开头
2. 尽量使用英文作为变量名， 若使用汉语拼音，必须注释清楚
3. 正确：userName 不好的：UserName，username
   4.静态变量，即使用static修饰，命名跟成员变量一样，如：static int totalNumber
   5.布局变量，即在方法中定义的变量，命名跟成员变量一样

2.5常量名

1. 常量名必须全部为大写
2. 各单词必须以下划线分开，以便区分
3. 对于枚举类常量

2.6包名

1. 包名必须小写
2. 包名尽量简洁，一个单词或缩写
3. 包名不能以数字开头，尽量只包含字母

2.7类名

1. 大驼峰式命名，即单词首字母大写，如：UserService
2. 接口名不加前缀
3. 抽象类名以Abstract开头
4. 接口实现类名必须加上Impl

三．格式规范

3.1排版规范

1. 缩进必须用space，不能使用tab键
2. 单行字符数不超过120个
3. 开发工具建议使用android studio，工具稳定性好，智能化。

3.2 注释规范

1. 类名，功能方法接口名称必须有注释
2. 复杂代码逻辑必须有注释
3. 代码注释不超过一行使用\'//\'，超过一行使用‘/* */’