开发规范

2021-06-08  本文已影响0人  臭臭的胡子先生

1.命名规范

1.css-test name - 下划线
2.js-testName - 驼峰
3.文件夹及文件,静态资源 -驼峰

2.备注

1.data内申明的key备注用意
2.定义js方法需要备注用意
3.在js关键逻辑需要备注
4.if判断需要备注清楚
5.html按照模块添加备注
6.css按照模块添加备注,模块之间需要间隔线

3.逻辑嵌套

1.if逻辑不能嵌套太深,如果业务需求,就拆分出来
2.能用async await 就不要用各种嵌套(根据业务定,总之不要有太多的异步嵌套
3.页面之间交互,尽量使用路由传值的方式去交互,尽量减少使用本地储存及全局存值,避免出现业务变更逻辑混乱的问题

4.代码格式

1.使代码空格缩进使用2个字符
2.代码提交git需要使用编辑器格式化代码

5.开发要求

1.按照业务拆分定义一级文件目录,在对应的文件开发,禁止一级文件同级出现页面,定义好文件名后在项目的README.md文件内按照文件目录格式备注清楚,例子会放在最下方
2.严格按照ui图1:1还原
3.开发时data内定义好mock数据,写清楚页面中的功能及逻辑,后台提供api后只需要请求接口项目即可跑起来
4.项目中图片先压缩(https://tinypng.com/)
       4.1.小程序项目因为包的体积,项目内只能放小于1.5k的,不符合则丢到cdn上
        4.2.移动端项目,图片不能大于50k,不符合则丢到cdn上
        4.3.pc项目,图片不能大于100k,不符合则丢到cdn上
5.修改别人代码,需要先与相关开发确定此代码是否绑定别的逻辑并在页面中进行简单的备注修改原因
6.小程序开发,业务逻辑非必要不要再onShow里面进行调用,如果需要修改前一个页面的内容,尽量使用小程序提供的( getCurrentPages())方法去刷新,尽量使用物理刷新
7.多端开发,有需要兼容代码加好判断,只在当前运行环境生效(uni-app)
8.做好项目开发时间评估,根据评估时间稳步推进
9.根据业务封装组件,要求组件清晰,调用简单最好是使用者只引用,组件内做好逻辑处理
10.小程序开发必须添加强制更新
11.小程序开发后期,基本功能完成后每天下班之前提测,让微信那边去审核,保证每天上班之前正式版能是最新的状态
12.移动端开发input输入框长度限制禁止使用系统的maxLenget去限制,根据限制字数,使用v-module赋值,slice截取长度限制去处理

6.git使用

1.开发过程中,每个人建立一个分支,每天下班之前将自己分支的代码合并到dev分支,禁止在dev分支开发
2.如果需要调研或者测试,以dev开一个新分支去测试,禁止在业务代码中出现测试代码
3.上线时将代码合并至master,以master为主进行打包上线,上线结束以master创建一个新分支进行版本记录

项目文件目录梳理

│--components   公共组建 
│   │
│   │ 
│   │--common
│   │   │   loading.vue       loading
│   │   │   sharePopup.vue     分享弹框组建
│   │
│   │
│   │--home
│   │   │   index.vue       首页相关组件
│   │      
│   │
│─-view 页面布局文件
│   │ 
│   │--home   首页文件
│   │   │   index.vue     首页
│   │      
│   │
│─-utils 公共js文件
│   │   httpRequest.js  http请求js
│   │   utils.js        公共js
│   │   preventReClick.js        防连点js  
上一篇 下一篇

猜你喜欢

热点阅读