这个作业属于哪个课程 | 至诚软工实践F班 |
---|---|
这个作业要求在哪里 | 作业要求链接 |
这个作业的目标 | 制定代码规范与冲刺计划 |
参考资料 | 华为内部代码规范,阿里巴巴java开发手册 |
前端主要参考各个互联网大厂的Web前端代码规范指南作为规范。
- 缩进
- 采用4个空格,禁止使用tab字符;
- 空格
- 二元运算符两侧必须有一个空格,一元运算符与操作对象之间不允许有空格;
- 用作代码块起始的左花括号 { 前必须有一个空格;
- 函数声明、具名函数表达式、函数调用中,函数名和 ( 之间不允许有空格。);
- 命名
- class 必须单词全字母小写,单词间以 - 分隔;
- class 必须代表相应模块或部件的内容或功能,不得以样式信息进行命名;
- 同一页面,应避免使用相同的 name 与 id;
- 元素 id 必须保证页面唯一;
- 图片
- 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src;
- 每行最多字符数
- 120个字符
- 通用规则
- DOCTYPE:使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYPE;
- 编码:页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素;
- CSS 和 JavaScript 引入:引入 CSS 时必须指明 rel="stylesheet";
- JavaScript 应当放在页面末尾,或采用异步加载;
后端主要使用阿里巴巴的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
时间区间 | 任务内容 | 完成状态 |
---|---|---|
5.20-5.21 | 进行项目环境配置、项目启动会议 | 已完成 |
5.22-5.23 | 各模块工作初期 | 已完成 |
5.24-5.27 | 各模块任务大体完成,有基本功能实现 | 进行中 |
5.28-5.31 | 前后端交互、功能模块优化 | 进行中 |