前端日常规范

To Be A Better Coder

无规矩不成方圆,一套规范良好的代码,起码可以有两方面的好处:
(1).提高团队开发效率。
(2).有利于项目的后期维护。

一、规范

1、代码注释

注释!注释!注释!想想自己接手一个没有注释的项目去维护的情景就能理解了。

2、代码格式化

代码提交前都应该执行格式化,并且统一格式化插件,如统一使用prettier/Eslint/Tslint等;

3、命名

如文件夹/文件命名、组件命名、函数命名等,都应该尽量执行对应的如大小驼峰命名、常量全大写等命名规则;

4、代码引入顺序

划分类库、component、本地 utils、本文件 const 声明/处理等,规则尽可能统一;


5、页面 export

应该通过当前目录 index.js 适当组织代码,统一 export,减少 import 次数;


6、路由表模块化

路由表应该按需分成模块拆分引入,而不应该统一写在一个文件内


7、组件封装强内聚

组件内部应尽可能的不含有业务逻辑,除非是多用性的业务类组件;

8、git 分支提交代码规范

比如·Fixd:修复 xxxxbug--41234·,测试提交对应的 bug,后面是 bug 对应的 id;

9、产品/后端接口不规范

前端应该主动推动,如产品需求文档不明确、后端接口字段语义不明/多个关联的接口同个类目返回的字段数目已经名称不一/表单使用 get 请求等,前端 er 们应该主动提出建议,并让对应负责人沟通,统一规范;

二、代码

很多小问题尽管产品不要求,前端也应该自主的实现。

1、日期/时间

日期/时间选择应该禁用小于当前的日期/时间;

2、防抖 debounce

如搜索/提交等按钮事件,输入框 onchange 等,都应该要做防抖 debounce 处理;

3、页面/组件

不管是自用还是公用,都尽可能添加注释,且逻辑函数体内应该简洁高效;

4、数据处理

数据请求回来,都应该自己先截流一层,最后才返回自己想要的数据去触发渲染,这样可以避免两个问题:

  • 避免后端接口少字段或者改字段名称引起的错误,前端在拦截的时候要兼容对应错误;
  • 数据返回量可能会极大,拦截一层可以避免引起不必要的计算,提高性能;

5、多个异步事件

应该确保执行的顺序问题,如页面初始化需要同时进行两个请求,如有关联,应使用 promise 等方法同步处理;

6、接口请求

成功提示可以按需反馈,但失败提示不应该遗漏,可以通过如 axios 拦截器或者请求做catch 处理

7、对象/数组

对如对象字段引用、数组遍历等,使用前必须先判断值是否存在,如obj && obj.name && ...arr && arr.length >0 && arr.map(...);如果不做对应处理尤其后端接口返回值为 null 的时候很容易引起 js 报错;

8、默认展示/默认处理

如错误提示、错误图片应该加载的默认图等;


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容