.vue文件书写规范

template 模块

1. <template> 标签上不要写多余的属性(默认就是以 html 来解析)
<!-- Not recommended -->
<template lang="html"></template>
<!-- Recommended -->
<template></template>


2. template 里 html 标签上的属性书写规则

2.1 超过一个属性时,属性换行对齐;

2.2 v-xx指令放最前,自有属性放最后;

<!-- Not recommended -->
<input type="text" class="hf-input" placeholder="请输入验证码" v-model="form.imageCode" />
<!-- Recommended -->
<input
  v-model="form.imageCode"
  type="text"
  class="hf-input"
  placeholder="请输入验证码"
/>

2.3 v-xx指令排序规则,控制显示 -> 控制循环 -> v-bind属性 -> v-on事件绑定;

v-if / v-show -> v-for -> v-bind:text... -> v-on:click...

如:

<!-- Recommended -->
<ul v-if="todos.length > 0">
    <li
      is="todo-item"
      v-for="(todo, index) in todos"
      v-bind:key="todo.id"
      v-bind:title="todo.title"
      v-on:remove="todos.splice(index, 1)"
    ></li>
  </ul>

2.4 当v-ifv-for在同一个标签上时,记得v-if的权重高于v-for,会在每个标签上做判断,确定这是你真正的意图?

2.5 v-for时,记得为每项提供一个唯一 key 属性;

2.6 非不得已,请不要写html标签上直接写style内联样式!


3. 在大结构块时,加入合适的注释标签,并保持良好的层级缩进;
<div>
  <!-- “导入”组件 -->
  <div>
    xxx
  </div>
  <!-- “导入”组件/ -->
  <!-- 搜索框 -->
  <div>
     xxx
  </div>
  <!-- 搜索框/ -->
</div>



script 模块

1. import 放在最顶部,并省略掉 .js.json.vue 后缀(已在webpack的resolve.extensions中做了配置)
<!-- Not recommended -->
import mockData from '@/mockdata/userMock.js'
<!-- Recommended -->
import mockData from '@/mockdata/userMock'


2. export 对象中属性定义顺序

name 当前模块名字
components 便于查找引用了哪些组件(单个换行,以,结尾

<!-- Recommended -->
components: {
  norecord,
  TimePicker,
},

props 可接受的从父组件传递过来的参数列表

  1. props 值必须为对象;
  2. 如果是必传项,要设置 required:true
  3. 如果有默认值(最好都有默认值),要设置 default 的值;
  4. props 的每个字段添加注释,方便后期维护
<!-- Recommended -->
props: {
  // 学生数量
  stuCount: Number,
  // 是否正在加载(带有默认值)
  isLoading: {
    type: Boolean,
    default: false,
  },
  // 是否正在创建(如果是必传项)
  isCreating: {
    type: Boolean,
    required: true,
    default: false,
  },
},

data 记得是一个 function,保证每个实例可以维护一份被返回对象的独立的拷贝
computed 计算属性
watch 监听器
filters 过滤器
directives 指令
mixins 混入
methods 方法

  1. 方法按页面结构从上至下开始定义;
  2. 属于某一个功能项的尽量放在一起,并加上此功能项的起止注释;
  3. 页面初始化方法写在最后;
  4. 公用方法写在页面初始化方法前,页面其他功能项方法后;
<!-- Recommended -->
methods: {
    // 添加课程
    addClass() {

    },
    // 删除课程
    delClass() {

    },

    /** 上传模块的功能 start */
    // 上传成功
    uploadSuc() {

    },
    // 上传失败
    uploadFail() {
        
    }, 
    /** 上传模块的功能 end */

    /** 共用方法 start */
    // 转换成树结构
    convertToTree() {

    },
    // 表单校验
    checkForm() {

    },
    /** 共用方法 end */

    // 初始化一些信息
    init() {

    },
},

created/mounted/updated 等各类生命周期函数

<!-- Recommended -->
methods: {
    
},
/** 生命周期勾子函数 start */
beforeCreated() {

},
created() {

},
mounted() {

},
/** 生命周期勾子函数 end */



style 模块

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