常见的前端开发规范

本文为吸取各方意见加头脑风暴,并根据实际运用场景调整汇总而成,如有雷同,纯属巧合,见谅见谅。

一、常规规范

1. 属性顺序

eslint规定的格式要求,开启eslint自动校验模式,自动修正

2. id / class 命名规则

① 首先根据内容命名,如 header footer

② 若根据内容无法找到合适的命名,再结合行为表现进行辅助, e.g. col_main blue_box

③ 名字一律小写,使用下划线命名法,可基于最近的父元素名称作为前缀

④ 在不影响语义的情况下,可适当使用缩写,但是缩写只用来表示结构, e.g. col nav btn etc. ,避免自编.

⑤ 避免广告拦截词汇 e.g. ad ads adv banner sponsor gg guangg guanggao etc.

二、CSS 规范

① 标注关键性注释

② PC端使用px,移动端统一使用rem(100px -> 1rem)

三、 JS 规范

1. 语言规范

① 声明变量须使用 let或const 关键字.避免使用 var

② 优先使用箭头函数

③ 使用模板字符串取代连接字符串

④ 避免出现简写方式,如:

if(true) return false;
2. H5使用分号

如果仅依靠语句间的隐式分隔,有时会很麻烦,使用分号更能清楚哪里是语句的起止,而且有些情况下,漏掉分号会出 BUG

3. 命名规范

① 变量名/参数名/属性: 使用下划线命名法 如 name_id

② 函数名/方法: 使用小驼峰命名法 如 getData()

③ 功能模块: 使用大驼峰命名法 如 CollectFace,内部文件使用小驼峰命名

④ 杜绝完全不规范的缩写,避免望文不知意。(如:condition 缩写成 condi)

⑤ 为达到见名知意,使用尽量完成的单词组合来表达其意,如:

· 查询类的方法用get做前缀(如:getBatchData)

· 新增的方法用add做前缀

· 删除的方法用delete做前缀

· 修改的方法用update做前缀

4. 声明

① 在函数的开始应先用 let 关键字声明函数中要使用的局部变量

② 注释变量的功能及代表的含义,且应以字母顺序排序.每个变量单独占一行以便添加注释

5. 回调函数规范

① 回调函数统一使用 Promise 函数,回调成功的参数统一为 response,错误参数为 error

② 每个函数之间用一个空行分离结构

6. 数据绑定变量定义规范

所有涉及到数据绑定的变量均需在 data 中初始化.禁止在不定义的情况下直接 setData,或者出现 undefined

涉及到数据绑定的变量写 data 中

四、组件规范

① 公用组件夹需以大驼峰式命名,组件内部文件默认index.vue.

② 组件标签在 page 页面使用时推荐使用单闭合标签,包含 slot的组件除外

③ 组件引用时,components中使用大驼峰,template中引用使用小驼峰

五、标点规范

① JS 中一致使用反引号 ` 或单引号 ‘’ , 不使用双引号

② WXML CSS JSON 中均应使用双引号。

六、注释声明

1. 文件头声明

vscode安装【koroFileHeader】插件,并在扩展配置文件(settings.json)中,配置如下:

"fileheader.customMade": { // 头部注释
        "MoudelName": "模块名称",
        "Company": "Copyright(c)2021因沃特科技.Allrightsreserved",
        "Author": "XWJ",
        "CreateDate": "Do not edit",
        "LastEditors": "XWJ",
        "LastEditTime": "Do not edit",
        "Description": "file content",
    },
    "fileheader.cursorMode": { // 头部注释
        "description": "",
        "param": "params",
        "return": ""
    },
    "fileheader.configObj": {
        
        "createFileTime": true,
        "createHeader": true,
        "autoAdd": true, // 默认开启自动添加头部注释,当文件没有设置头部注释时保存会自动添加
        "autoAlready": true, // 默认开启
        "prohibitAutoAdd": [
            "json",
            "md"
        ], // 禁止.json .md文件,自动添加头部注释
        "wideSame": false, // 设置为true开启
        "wideNum": 13 // 字段长度 默认为13
    }

扩展配置文件入口:

image.png
2. 代码内注释

① 独占一行的变量,注释紧随其后,否则于变量上方注释

② 函数注释于其上方,参数注释紧随其后

③ 复杂逻辑判断处应标注说明

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

推荐阅读更多精彩内容

  • web开发约束 项目结构: vue项目结构 vue命名约束 语义化和命名 应以功能或内容命名,不以表现形式命名;命...
    侬姝沁儿阅读 4,130评论 0 7
  • 命名编码规范 驼峰式命名法介绍 -Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo...
    莫言默言阅读 3,777评论 0 5
  • 最佳原则 坚持制定好的代码规范。无论团队人数多少,代码应该同出一门。如果你想要为这个规范做贡献或觉得有不合理的地方...
    Tiny_ae3d阅读 1,615评论 0 1
  • 一、概述 本规范旨在为前端程序的开发者提供规范化最新的指导,可用于程序员个人编译环境以及研发团队集成环境等场合的代...
    flyinskybiu阅读 3,066评论 0 2
  • 前端开发规范 规范目的 命名规范 结构化规范 注释规范 编码规范 CSS 规范 规范目的 为提高团队协作效率 便于...
    妹妹十六阅读 168评论 0 0