Vue单文件组件命名规范

Vue单文件组件命名规范

一直想写一篇Vue项目结构及组件内属性 方法命名规范的博客,今天终于腾出时间来写了,也算是个人的总结;这篇博客借鉴了另一篇博客,值的推荐,个人也是在此基础上加了一些个人的习惯用法;

views文件夹及子级命名

views文件夹是所有视图的文件入口,包括所有的视图以及视图集合模块

views下文件夹

  1. views 下面的文件夹代表着模块的名字,一般由单个小写名词命名,以便与vue文件区分,(good: car order cart bad: carInfo carpage)

views下vue文件

  1. views 下面的 vue 文件代表着页面的名字,只有一个文件的情况下直接放在文件夹之下,例如Login Home
  2. 以名词命名,大写开头,开头的单词即所属模块名字(CarDetail、CarEdit、CarList)
  3. 常用结尾单词有(Detail、Edit、List、Info、Report)
  4. 以 Item 结尾的代表着页面复用的组件(CarListItem、CarInfoItem)

vue单文件组件属性命名

vue固定属性声明顺序

这个顺序纯是个人习惯,不喜欢可以按照自己的习惯声明就好;

  1. name
  2. components
  3. props
  4. data
  5. computed
  6. methods
  7. watch
  8. filter
  9. created mounted beforeUpdate等常用的生命周期
  10. beforeRouteEnter beforeRouteUpdate等组件内路由生命周期

剩下的不再列举,根据个人习惯就好;个人建议状态类属性 函数类属性作为两个大的集合区分

method 命名

  1. ajax 方法以 get、post 开头,以 data 结尾(**good:getListData、postFormData)(bad:takeData、confirmData、getList、postForm)
  2. 事件方法以 on 开头(onTypeChange、onUsernameInput)
  3. 逻辑处理方法,语义化命名;handleSearch handleUpdate
  4. 遵循驼峰命名法

data props computed 命名及注意

  1. 使用 data 里的变量时必须先在 data 里面初始化
  2. props 指定type及默认值
  3. 个人建议用 名词与 _ 组合命名,例如xx_xx_xx,在管理state比较多时,省的苦思冥想那么多命名
  4. 表单数据请包裹一层 form,在其中声明每个表单域对应的命名即可

就是这些,有错误欢迎指正;

Vue 3组件命名规范并没有强制性的规定,但遵循一定的命名习惯可以帮助提高代码的可读性和一致性。以下是社区中常用的一些Vue组件命名规范建议: 1. 文件组件(SFC)文件命名应该使用短横线分隔的小写词(kebab-case)。例如,`MyComponent.vue`。 2. 组件的标签名(在文件组件中定义的`<script>`标签内的`name`选项)也建议使用短横线分隔的小写词,这样可以保持与文件名的一致性。例如: ```javascript export default { name: 'my-component' } ``` 在这个例子中,组件的标签名会是`<my-component>`。 3. 大小写混合的PascalCase命名方式(首字母大写的驼峰命名法)也是可行的,特别是在JavaScript代码中引用组件时。例如: ```javascript import MyComponent from './MyComponent.vue'; ``` 在这种情况下,引用组件时使用的是PascalCase命名。 4. 在模板中使用组件时,遵循与组件标签名相同的命名规范。如果使用短横线分隔的小写命名,则在模板中也应该这样使用;如果使用PascalCase,则模板中也使用PascalCase。 5. 避免使用保留的HTML标签名,如`<div>`、`<span>`等,作为自定义组件的名字,以免造成混淆。 6. 如果组件是复数形式,则标签名也应该使用复数形式。例如: ```html <user-profiles></user-profiles> ``` 7. 组件命名应尽量具有描述性,能够直观地表达组件的功能或内容,避免使用无意义的命名。 8. 对于全局组件,建议在组件名前加上前缀,如`Base`、`App`或`Global`等,以区分全局组件和局部组件。例如: ```javascript export default { name: 'BaseButton' } ``` 遵循这些规范可以使得Vue项目中的组件命名更加规范和一致,便于团队协作和代码维护。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值