星辰大海组-凡事预则立

Posted 2021-06-01 星辰大海组

这个作业属于哪个课程	https://edu.cnblogs.com/campus/zswxy/computer-science-class2-2018
这个作业要求在哪里	https://edu.cnblogs.com/campus/zswxy/computer-science-class2-2018/homework/12065
这个作业的目标	<凡事预则立>
小组的组号和队名	星辰大海组
小组的队长姓名	谢思敏

目录

• 一、冲刺任务与计划
• 二、代码规范
  • 1. 命名规范
    • 1.1 总体命名规则
    • 1.2 变量名
    • 1.3 常量名
    • 1.4 包名
    • 1.5 类名
  • 2. 排版规范
  • 3. 注释规范
  • 4. 代码提交规范
• 团队代码仓库：

一、冲刺任务与计划

---

时间\\任务	前端	后端
6.4	项目部署、熟悉开发环境	项目部署、熟悉开发环境
6.5	登录页面	登录接口
6.6	个人中心页	个人中心页相关接口实现
6.7	整体部署	整体部署
6.8	视频页	视频播放接口
6.9	歌曲详情页面	歌曲播放功能
6.10	功能完善	音乐搜索接口
6.11	前后端连接测试与完善	前后端连接测试与完善

二、代码规范

参考主流代码规范：https://www.cnblogs.com/S031602240/p/10551854.html

1. 命名规范

1.1 总体命名规则

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

1.2 变量名

1. 小驼峰式命名，变量名首字母必须为小写字母，不使用 “_” 作为变量名(包括成员变量)开头
2. 尽量使用英文作为变量名， 若使用汉语拼音，必须注释清楚
3. 正确：userName   错误：UserName，_UserName,username ```

1.3 常量名

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

1.4 包名

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

1.5 类名

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

2. 排版规范

1. 缩进必须用space，不能使用tab键，可以在eclipse或其他开发工具配置一个tab用4个space代替。
2. 单行字符数不超过120个
3. 开发工具建议使用微信开发工具，工具稳定性好，智能化，内存消耗稳定。
4. 其他？可以使用工具自动格式化功能

3. 注释规范

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

4. 代码提交规范

1. 原则上完成一个完整功能并自测无异常后，方可checkin代码，必须保证无编译报错
2. 提交代码必须写注释，能够完整描述本次提交变更的内容

团队代码仓库：

https://gitee.com/fengmixinluo/fengmixinluo.git