标签：功能模块 界面 前缀 代码 规范 冲刺 ---- 对队 命名
| 这个作业属于哪个课程 | 至诚软工实践F班 |
|---|---|
| 这个作业要求在哪里 | 作业要求链接 |
| 这个作业的目标 | 制定代码规范与冲刺计划 |
| 参考资料 | 华为内部代码规范，阿里巴巴java开发手册 |
一、代码规范
1.Web前端代码规范
前端主要参考各个互联网大厂的Web前端代码规范指南作为规范。
- 缩进
- 采用4个空格，禁止使用tab字符；
- 空格
- 二元运算符两侧必须有一个空格，一元运算符与操作对象之间不允许有空格；
- 用作代码块起始的左花括号 { 前必须有一个空格；
- 函数声明、具名函数表达式、函数调用中，函数名和 ( 之间不允许有空格。）；
- 命名
- class 必须单词全字母小写，单词间以 - 分隔；
- class 必须代表相应模块或部件的内容或功能，不得以样式信息进行命名；
- 同一页面，应避免使用相同的 name 与 id；
- 元素 id 必须保证页面唯一；
- 图片
- 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src；
- 每行最多字符数
- 120个字符
- 通用规则
- DOCTYPE：使用 HTML5 的 doctype 来启用标准模式，建议使用大写的 DOCTYPE；
- 编码：页面必须使用精简形式，明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素；
- CSS 和 JavaScript 引入：引入 CSS 时必须指明 rel="stylesheet"；
- JavaScript 应当放在页面末尾，或采用异步加载；
2.后端代码规范
后端主要使用阿里巴巴的Java规范;并在此基础上，对Mapper代码、BO、DO、接口的写法制定了组内规范
- 代码命名不能以下划线或者美元符号开头或者结尾；
- 代码命名不能以中文拼音或者中文拼音与英文混合方式；
- 类名使用UpperCamCamelCase风格，但DO、PO、DTO、VO、BO等除外；
- 方法名、参数名、变量名统一使用lowerCamelCase，必须遵守驼峰命名；
- 常量名全部大写，单词间用下划线隔开；
- 抽象类必须以Abstract或者Base开头，异常类必须以Exception结尾，测试 ；
- 类以测试的类的名称开头Test结尾；
- 类型与中括号紧挨相连标示数组；
- POJO类中布尔类型变量不要加is前缀；
- 包名统一小写，点分隔符有且有一个自然语义单词；
- 避免在父子类和不同代码块中采用相同变量名；
- 避免不规范的缩写命名；
- 在对元素命名时用完整单词组合表达其意；
- 各层命名规范：
（A) Service/DAO层命名规约
1.获取单个对象的方法用get做前缀
2.获取多个对象的方法用list做前缀，如：listObjects
3.获取统计值的方法用count做前缀
4.插入方法用save/insert做前缀
5.删除方法用delete/remove做前缀
6.修改方法用update做前缀
（B）领域模型命名规范
1.数据对象：xxxDO, xxx为数据库表名
2.数据传输对象：xxxDTO,xxx为业务模型相关名称
3.展示对象：xxxVO，xxx一般为网页名称
4.POJO是对DO、DTO、VO、BO的统称，禁止xxxPOJO
二、冲刺任务
1.前端部分
web前台
- 完成用户登录、注册、找回密码界面
- 完成主界面：展示日历与计划简略一览
- 完成小组功能模块界面：创建、加入、退出
- 完成计划功能模块界面：创建、编辑计划
- 完成用户设置修改功能模块界面：设置用户信息修改、密码修改
- 前后端数据交互
web后台
- 完成用户登录、注册、找回密码界面
- 完成主界面：进入默认管理用户信息、左边菜单栏依次显示用户、计划
- 完成计划功能模块界面：计划信息审核与修改、删除
- 完成用户信息审核功能：个人详情审核与修改、账号删除（封禁）
- 前后端数据交互
2.后端部分
计划功能模块
- 创建、编辑计划（编辑包括设置详细信息等接口）
设置功能模块
- 设置用户信息修改、密码修改等接口
工具类与模块交互
- util类编写，包含日期获取、Json格式等工具类整合
- 功能与计划功能交互，实现创建用户与管理用户计划
杂项
- 文档撰写
- 博客撰写
- 每日会议总结
3.具体日程安排
| 时间区间 | 任务内容 | 完成状态 |
|---|---|---|
| 5.20-5.21 | 进行项目环境配置、项目启动会议 | 已完成 |
| 5.22-5.23 | 各模块工作初期 | 已完成 |
| 5.24-5.27 | 各模块任务大体完成，有基本功能实现 | 进行中 |
| 5.28-5.31 | 前后端交互、功能模块优化 | 进行中 |
标签：功能模块,界面,前缀,代码,规范,冲刺,----,对队,命名 来源： https://www.cnblogs.com/addddui/p/16311224.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。