Vue 组件命名规范与编码风格指南

舞夢輝影

舞夢輝影

2026-07-21

221人浏览

原创

vue组件命名需遵循pascalcase多词规范以避免冲突,文件名用kebab-case确保兼容性,基础组件加base-前缀,业务组件按功能分层,模板中使用pascalcase自闭合标签,并规范props和data命名与声明。

vue 组件命名规范与编码风格指南

Vue 组件命名不是随便起个名字就行,它直接关系到可读性、协作效率和长期维护成本。核心原则是:避免冲突、见名知意、统一风格。

组件名称(name 选项)用 PascalCase,且必须多词

组件的 name 选项必须是多个单词组成的 PascalCase 格式,比如 UserInfoCardOrderSummaryPanel。这能防止与 HTML 原生标签(如 buttonmenu)或未来可能新增的标签重名。

  • ✅ 正确:name: 'UserProfileHeader'
  • ❌ 错误:name: 'userprofileheader'(小写)、name: 'UserProfile'(仅两词但实际语义单薄)、name: 'user-profile-header'(kebab-case 不适用于 name 选项)

组件文件名统一用 kebab-case

文件系统对大小写不敏感,所以 MyButton.vuemybutton.vue 在某些环境中可能冲突。官方推荐使用 kebab-case 文件名,如 base-button.vueuser-profile-options.vue,既清晰又安全。

Vue-router参考手册
Vue-router参考手册

Vue-router参考手册下载

下载
  • ✅ 推荐:base-input.vuetodo-list-item.vue
  • ❌ 避免:BaseInput.vue(易在 Windows/macOS 上出错)、mycomponent.vue(不易识别,违反语义)

基础组件加 base- 前缀,业务组件按功能分层命名

通用型、无业务逻辑的原子组件,统一以 base- 开头;与特定页面或模块强关联的子组件,则用父组件名作前缀,保持上下文明确。

  • 基础组件:base-button.vuebase-icon.vue(不用缩写,如 btnico
  • 业务耦合组件:product-detail-tabs.vuecheckout-step-summary.vue
  • 避免模糊命名:Info.vueItem.vue 这类名字无法体现用途,应改为 UserContactInfo.vueCartItem.vue

模板中使用组件时用 PascalCase 自闭合写法

<template></template> 中引入组件,应采用 PascalCase 并写成自闭合标签,这是 Vue 模板解析器的标准识别方式,也利于 IDE 补全和语法高亮。

  • ✅ 正确:<userprofilecard></userprofilecard><basebutton size="large"></basebutton>
  • ❌ 不推荐:<user-profile-card></user-profile-card>(冗长)、<base-button></base-button>(与文件名混淆,且非标准写法)

Props 和 data 的配套规范不能忽略

命名只是第一步,配合的细节决定质量:

  • Props 使用 camelCase,必须声明类型(type),并明确 requireddefault
  • Data 必须为函数返回对象,避免多个实例共享同一引用
  • 所有组件建议启用 scoped 样式,防止样式污染
  • 复杂属性建议换行书写,提升可读性:
    :visible="isModalOpen"<br>:on-confirm="handleConfirm"<br>:disabled="isLoading"

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vue

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1085

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

2210

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

2103

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

2255

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

334

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

679

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

10598

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

153

23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 15.5万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 2.2万人学习