web前端代码基础规范

1、组件命名规范

组件名应该始终是多单词的,根组件 App 以及 transition、component 之类的 vue 内置组件除外。

这样做可以避免跟现有的以及未来的 HTML 元素相冲突,因为所有的 HTML 元素名称都是单个单词的。

组件命名应该采用PascalCase(首字母大写)命名规范,例如:MyComponent

组件名应该倾向于完整单词而不是缩写。

2、组件文件命名规

要么始终是单词大写开头 (PascalCase),要么始终是横线连接(kebab-case)。例如:

MyComponent(.vue) //全局组件

my-component(.vue) // 业务文件/ 页面组件

和父组件紧密耦合的子组件 应该以父组件 名作为前缀命名

components/

-ToDoList.vue

-TodoListitem.vue

-TodolistItem.vue

3、组件属性命名规范

在声明  prop  的时候,其命名应该始终使用camelCase(小驼峰式),例如:myProp

而在模板(.vue)和 JSX中应该始终使用kebab-case.

4、组件事件命名规范

组件事件 命名应该采用 kebab-case (短横线分隔)命名规范,例如:my-event。

JS规范

1、缩进

使用2个空格(Tab缩进有的默认两个空格)进行缩进。

2、变量命名

变量名使用驼峰式(小)命名法,首字母小写inputStr

3、常量命名

常量名使用大写字母和下划线命名法,所有字母都大写,单词之间用下划线分隔MY_CONFIG

4、函数命名

函数名使用驼峰式命名法,首字母小写editProduct,统一使用动词 或者动词+名词 形式

5、注释

注释应该清晰明了,使用单行注释(//) 或多行注释 (/*..*/)

6、空格

在运算符、取变量;js 、css 冒号前后加上空格,使代码更易读。

7、引号

使用单引号或双引号都可以,但是在整个项目中应该保持一致。

8、函数

函数应该尽量简单,只做一件事情。函数的参数应该尽量少,不要超过 3个,少用闭包函数,特殊情况使用必须主动删除。

9、条件语句

条件语句应该尽量简单,不要嵌套过多、括号中不能过多逻辑计算。

10、循环语句

循环语句应该尽量简单,不要嵌套过多。

11、对象

对象的属性名 应该使用 驼峰式 命名法,首字母小写className

12、数组

数组应该使用字面量 表示法,而不是使用构造函数。

13、类

类的命名应该使用驼峰式 命名法,首字母大写MyClass,

14、模块

模块应该使用 ES6 (import) 的模块语法,而不是使用 Common.js

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

推荐阅读更多精彩内容