【vue中文件及文件夹命名规范详细介绍】

这篇具有很好参考价值的文章主要介绍了【vue中文件及文件夹命名规范详细介绍】。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1. 介绍

在 Vue 项目中,合理的文件和文件夹命名对于代码维护和团队协作非常重要,没有官方的强制性规范,但社区有一些通用的最佳实践:

2. 命名规范

Vue 组件的命名规范通常遵循以下几种风格:

  • 1. 命名法
    1.1 驼峰式命名法(camelCase)
    1.2 短横线命名(kebab-case)全小写
    1.3 帕斯卡命名法(PascalCase)

  • 2. 文件夹命名
    2.1 kebab-case
    2.2 尽量使用名词,尽量使用一个单词

  • 3. *.js文件命名规范
    3.1 所有模块的主文件index.js全小写
    3.2 属于组件的.js文件,使用PascalBase风格
    3.3 其他类型的.js文件,使用kebab-case风格

  • 4. *.vue文件命名规范
    4.1 除index.vue之外,其他.vue文件统一用PascalBase风格

  • 5. *.less文件命名规范
    统一使用kebab-case命名风格

前三点比较重要,需要记住

附录一:.less为后缀的文件是什么
1、less是什么:LESS 为 Web 开发者带来了福音,它在 CSS 的语法基础之上,引入了变量,Mixin(混入),运算以及函数等功能,大大简化了 CSS 的编写,并且降低了 CSS 的维护成本,就像它的名称所说的那样,LESS 可以让我们用更少的代码做更多的事情。
2、为什么有lessCSS 是一门非程序式语言,CSS 需要书写大量看似没有逻辑的代码,不方便维护及扩展,不利于复用
3、less最最最简单实例:使用@符号来定义变量

3. 文件夹名

文件夹名称通常遵循如下几种风格:

  • 全小写并使用连字符分隔: 对于存放组件的文件夹,常见的是使用 kebab-case,如 user-profile 文件夹内部可能包含 UserProfile.vue 和相关组件文件。

  • 模块性和复用性: 将相关组件组织在同一个文件夹中,例如,你可能有一个 users 文件夹,它包含有关用户组件的所有东西。

4. 路由和子文件夹

如果项目中使用 Vue Router 并遵循路由的结构来组织代码,文件夹名称通常与路由路径一致。例如,对于路由 /users/list,可以有一个名为 users 的文件夹,里面有一个名为 List.vue 的组件。

5. 单文件组件的大写字母

Vue 单文件组件(SFC)推荐使用帕斯卡命名法,文件内的 <script><template><style> 标签中的代码,遵循其对应的 JavaScript、HTML 和 CSS 标准的命名规范。

6. 测试文件

测试文件的命名通常与它们正在测试的文件相匹配,并加上.spec.test后缀。例如,UserCard.spec.jsUserCard.test.js

7. 约定性书写

  • 大型项目: 对于大型项目,有时可能需要在文件名中添加更多上下文,例如 UserCardPopup.vueUserCardForm.vue 等,以区分项目中的不同类型的组件。

  • 多单词组件名称: Vue 官方风格指南推荐,组件名称应该始终是多单词的,以防止与现有和未来的 HTML 元素冲突,例如使用 UserProfile 而不是 Profile

记住,最重要的是项目内部的一致性,选择一种风格,并贯穿整个项目,同时,如果你加入已存在的项目,遵循项目现有的命名约定也同样重要,如果需要,可以在项目初期制定好命名规范,确保所有团队成员都遵循相同的规则。文章来源地址https://www.toymoban.com/news/detail-811735.html

到了这里,关于【vue中文件及文件夹命名规范详细介绍】的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 文心一言vs通义千问 之前端文件夹命名

    今天心血来潮想试试国内百度和腾讯的AI在解决前端难题–文件命名方面的效果。 如下: 综上,是百度会更贴近一些哈 大伙有什么命名的好工具嘛?

    2024年02月11日
    浏览(44)
  • git怎么处理文件夹名称大小写重命名问题

    比如提交代码的时候不小心把文件名 kaimo 命名成了首字母大写的 Kaimo ,并且提交到了 git 仓库里面 这个时候我们把手动把 Kaimo 文件夹改成首字母小写的 kaimo 我们发现 git 并没有提示该文件重命名了 第一步:设置 git 的大小写敏感 可以使用命令 或者找到项目的隐藏文件夹

    2024年02月06日
    浏览(50)
  • 如何批量提取不同文件夹下的图片并随机重命名

    无论是在为了跑深度学习模型而准备数据集,还是其他的一些用途,相信大家都会遇到一个问题:我所需要的图片分布在很多不同的文件夹下,但我不需要这么多文件夹,那么我如果要使用这些图片的话,就需要把这些文件夹下的图片一个个提取出来,然后再放到新建的文件

    2024年02月12日
    浏览(71)
  • [ 云计算 | AWS 实践 ] Java 如何重命名 Amazon S3 中的文件和文件夹

    本文收录于【#云计算入门与实践 - AWS】专栏中,收录 AWS 入门与实践相关博文。 本文同步于个人公众号:【 云计算洞察 】 更多关于云计算技术内容敬请关注:CSDN【#云计算入门与实践 - AWS】专栏。 本系列已更新博文: [ 云计算 | AWS 实践 ] Java 应用中使用 Amazon S3 进行存储桶

    2024年02月08日
    浏览(60)
  • Android 11.0 mtp模式下连接pc后显示的文件夹禁止删除copy重命名功能实现

    在11.0的系统rom定制化开发中,usb连接pc端的时候有好几种模式,在做otg连接pc端的时候,改成mtp模式的时候,在pc端可以看到产品设备 的显示的文件夹的内容,对于产品设备里面的文件在pc端禁止做删除重命名拷贝等操作功能的实现 MtpService负责启动MtpServer和加载存储设备的信

    2024年01月17日
    浏览(86)
  • Node.js 文件写入及文件夹交互操作

    目录 1、文件写入 1.1 同步写入文件 1.2 将内容追加到文件 2、文件夹交互 2.1 检查文件夹是否存在 2.2 创建新文件夹 2.3 读取目录内容 2.4 重命名文件夹 2.5 删除文件夹 在Node.js中写入文件最简单的方法是使用fs.writeFile()API。 您可以使用同步版本fs.writeFileSync(): 您还可以使

    2024年02月06日
    浏览(48)
  • Node.js:实现遍历文件夹下所有文件

    Node.js:实现遍历文件夹 代码如下 参考文章 如何使用Node.js遍历文件夹详解

    2024年02月13日
    浏览(53)
  • 【正点原子STM32】SYSTEM文件夹介绍(sys文件夹、deley文件夹、USART 文件夹、SysTick、printf函数、fputc函数、半主机模式)

    一、sys文件夹介绍 二、deley文件夹介绍 2.1、deley文件夹函数简介 2.2、SysTick工作原理 2.3、SysTick寄存器介绍 2.4、delay_init()函数 2.5、delay_us()函数 2.6、delay_ms()函数 三、USART 文件夹介绍 3.1、printf函数输出流程 3.2、printf的使用 3.3、printf函数支持 半主机模式简介 方法一:微库法

    2024年03月11日
    浏览(94)
  • Unity的工程中文件夹介绍

    知乎上看篇文章,讲学一样的东西有两种入门方式,一种方式是从简单的学起,另一种方式是基础的学起。所谓不管简单还是基础,两个都要同样的学。 这篇内容介绍博主自己学到的Unity工程的目录结构相关内容,最终还是以Unity的官方文档为准。当然网上各类分享很多,博

    2024年02月01日
    浏览(48)
  • 安卓的工程目录文件夹简单介绍

    当创建了一个安卓工程之后,系统会生成很多文件夹,那么这些文件夹都存放的是什么东西呢? src:存放java代码,有包,有文件。相当于普通java程序的src文件夹。 gen:存放自动生成的文件。R.java存放的是程序的页面、按键、文本等的id。 Android 4.4和Android Private Libaries:安卓

    2024年02月05日
    浏览(54)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包