找茬项目 | 服务治理平台 |
---|---|
开发人员 | 许敏 |
找茬人员 |
| 刘心瑜、刘金萍、王慧敏、魏孟皓、彭从豪、齐继超、许敏、轩梦文、曹荣、项烀焜、刘晓娟 | | 下期找茬 | 架构治理平台 |
代码来找茬
遵循规范:2022 前端工程师开发规范手册(v22.6.16)
https://www.yuque.com/docs/share/6f0825ad-6d9f-4d70-bbd1-ca1a4b5c694c
找茬规则
●每周四轮流对一个项目进行代码Reivew
●成员可对项目进行相互找茬,找出可优化的代码片段
●遵循规范给出调整建议并指出规范问题
●案例留档整理
找茬案例
找茬者 - 魏孟皓
优化代码片段一
// not good
changeType(val) {
const list = this.mapData.find((item) => item.value == val)
this.indexOption = list.children
this.scopeList.indexName = this.indexOption[0].value
},
// good
// 切换上报类型
changeType(val) {
const list = this.mapData.find((item) => item.value == val)
this.indexOption = list.children
this.scopeList.indexName = this.indexOption[0].value
},
该代码存在以下规范问题:
4.2 语法 【强制】多写注释,且多使用句子进行描述而不是词语
代码自测 check list
自查细则 | 是否通过 | 未通过原因/现象 | |
---|---|---|---|
常规检查 | 代码是否能正常运行? | ||
控制台是否有明显的报错? | |||
代码有没有达到预期需求效果? | |||
代码逻辑是否简单易懂? | |||
代码书写是否符合规范? | |||
是否尽可能组件化了? | |||
有没有重复造轮子? | |||
去掉大段被注释的代码? (如果注释代码是可用的,那就先提交未删除注释的代码到 Git 上,然后再提交删除了注释的代码,以后能回滚就可以) |
|||
按钮是否控制了单次点击? | |||
定时器是否随生命周期消除? | |||
安全检查 | 引入他人(公司内部或者其他外部机构)依赖包,是否存在不可用和版本升级导致功能不可用的风险? | ||
所有请求是否都使用了 https,包括图片链接,对 App 应用嵌入的页面,是否提供了 https 协议链接? | |||
代码注释或者文案中是否包含了敏感词汇? | |||
文档检查 | 是否有符合规范的注释?注释是否描述准确?对方法参数或者名词是否进行了解释? | ||
第三方库使用是否有完善文档? | |||
Readme 文档是否书写规范?是否对项目有准确描述? | |||
性能检查 | 页面加载是否超过了 3s?超过 3s 的原因是什么?有没有友好的提示? | ||
代码有没有明显影响性能的逻辑和计算? | |||
组件层级是否可控? | |||
组件通信是否正常? | |||
页面嵌套是否简单? |