Vue代码规范

1. 组件名为多个单词,避免跟现有以及未来的 html 元素相冲突
<BaseComponent />
2. props 定义,尽可能详细
props: {
  status: {
    type: String,
    default: "1",
    required: true
  }
}
3. 在组件上总是必须用 key 配合 v-for
4. 永远不要把 v-ifv-for 同时用在同一个元素上

当 Vue 处理指令时,v-forv-if 具有更高的优先级,导致每次重渲染的时候会遍历整个列表`

5. 为组件样式设置作用域
<style scoped>
.name {
  color: #999999;
}
</style>
6. 单文件组件文件名采用单词大写开头
<BaseComponent />
7. 基础组件名(例如自定义按钮、表格、输入框),以一个特定的前缀开头,比如 BaseAppV
<BaseButton />
<AppButton />
<VButton />
8. 单例组件名(不接受props,自己私人定制的组件),以The为开头
<TheButton />
9. 子组件应该以父组件名作为前缀命名

IDE通常会按字母顺序组织文件,所以这样可以把相关联的文件排在一起

components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
10.组件名中的单词顺序,以一般化描述的单词开头,以描述性的修饰词结尾

在自然的英文里,形容词和其它描述语通常都出现在名词之前

// 反例
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue

// 好例子
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue
11. 自闭合组件
<!-- 反例 -->
<MyComponent></MyComponent>
<!-- 好例子 -->
<MyComponent />
12. 组件名是完整单词而不是缩写
<!-- 反例 -->
<SdSettings />
<!-- 好例子 -->
<StudentDashboardSettings />
13. 指令都使用缩写形式
<input :value="newTodoText"/>
14. 组件模板只包含简单的表达式,复杂的表达式则应为计算属性或方法。
/** 反例 */
<div>
  {{
    fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }}
</div>

/** 好例子 */
<div>{{ normalizedFullName }}</div>
computed: {
  normalizedFullName: function () {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}
15. 选项式API顺序
components:
props
data
computed
watch
/** 生命周期钩子 */
beforeCreate
created
beforeMount
mounted
beforeUpdate
updated
activated
deactivated
beforeDestroy
destroyed
/** 方法 */
methods

参考地址:https://cn.vuejs.org/v2/style-guide/

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

推荐阅读更多精彩内容

  • 非原创,转公司的,觉得很不错想保存下来,侵权删 组件名为多个单词 组件名应该始终是多个单词的,根组件 App 以及...
    微笑是我_f8bb阅读 546评论 0 1
  • 项目规范 项目名称根据项目来命名。 项目层级文件夹按照业务功能命名。 合适的编译工具。 合适的代码规范插件。 合适...
    神秘的占卜家阅读 438评论 0 0
  • 1,vue文件命名:主文件以 XxxIndex.vue 命名,开头首字母大写;弹窗增删改查组件XxxDialog....
    小小烦恼阅读 506评论 0 0
  • 这里是官方的 Vue 特有代码的风格指南。如果在工程中使用 Vue,为了回避错误、小纠结和反模式,该指南是份不错的...
    youins阅读 5,737评论 0 5
  • Vue.js 开发规范目录及说明 版本v1.0日期2020-02-18 本文档为前端 vue 开发规范 规范目的 ...
    kkgo_阅读 1,082评论 1 11