【vue中文件及文件夹命名规范详细介绍】
在Vue项目中,文件和文件夹的命名遵循一定的规范可以提高代码的可读性和可维护性。以下是一些常见的Vue组件和文件夹的命名规范:
组件文件命名:
- 单文件组件(*.vue):使用大驼峰命名法,例如
MyComponent.vue
。 - JavaScript组件:使用大驼峰命名法,例如
MyComponent.js
,内部组件名name: 'MyComponent'
。
- 单文件组件(*.vue):使用大驼峰命名法,例如
文件夹命名:
- 通常使用小写命名,可以包含短横线(
kebab-case
),例如my-component
或views
。 - 可以使用大驼峰命名法,但通常不推荐,除非是为了和已有的大驼峰组件名保持一致。
- 通常使用小写命名,可以包含短横线(
路由文件夹和文件命名:
- 路由文件夹:通常为
views
或routes
。 - 路由文件:通常为
index.js
或router.js
。
- 路由文件夹:通常为
- mixin文件命名:通常为
mixins
文件夹,文件使用大驼峰命名法,例如MyMixin.js
。 - store模块文件命名:通常为
store
文件夹,模块文件使用小写命名,可以使用横线,例如user.js
或user-profile.js
。 - 样式文件命名:通常与组件同名,后缀为
.css
,.scss
,.sass
, 或.less
。 - 图片、字体、样式等资源文件命名:尽量保持简洁,使用小写,可以使用横线,例如
logo.png
或user-icon.svg
。 - 测试文件命名:与组件或其他文件同名,后缀为
.spec.js
或.test.js
。
示例代码:
components/
|- MyComponent.vue
|- MyComponent.js
|- my-component/
| |- index.js
| |- MyComponent.vue
| |- MyComponent.css
| |- MyComponent.spec.js
views/
|- HomeView.vue
|- AboutView.vue
router/
|- index.js
|- routes.js
store/
|- index.js
|- user.js
|- user-profile.js
mixins/
|- MyMixin.js
assets/
|- logo.png
|- user-icon.svg
|- styles/
| |- base.scss
tests/
|- unit/
| |- MyComponent.spec.js
|- e2e/
| |- HomeView.spec.js
这些是常见的Vue项目文件和文件夹的命名规范,开发者可以根据自己的项目需求和团队规范进行调整。
评论已关闭