vue命名规范

vue命名可遵循以下规则

1、有意义的名词、简短、具有可读性
2、以小写开头,采用短横线分割命名
3、公共组件命名以公司名称简拼为命名空间(app-xx.vue)
4、文件夹命名主要以功能模块代表命名
同时还需要注意:必须符合自定义元素规范: 使用连字符分隔单词,切勿使用保留字。app- 前缀作为命名空间: 如果非常通用的话可使用一个单词来命名,这样可以方便于其它项目里复用。  

views 命名

views 文件夹下面是由 以页面为单位的 vue 文件 或者 模块文件夹 组成的,放在 src 目录之下,与 components、assets 同级。

views 下的文件夹命名

1、views 下面的文件夹代表着模块的名字
2、由名词组成(car、order、cart)
3、单词只能有一个(优:car order cart)(差: carInfo carpage)
4、尽量是名词(优:car)(差: greet good)
5、以小写开头(优:car)(差: Car)

views 下的 vue 文件命名

1、views 下面的 vue 文件代表着页面的名字
2、放在模块文件夹之下
3、只有一个文件的情况下不会出现文件夹,而是直接放在 views 目录下面,如 Login Home
4、尽量是名词
5、大写开头,开头的单词就是所属模块名字(CarDetail、CarEdit、CarList)
6、名字至少两个单词(优:CarDetail)(差: Car)
7、常用结尾单词有(Detail、Edit、List、Info、Report)
8、以 Item 结尾的代表着组件(CarListItem、CarInfoItem)

vue 方法命名

vue 方法放置顺序
- components
- props
- data
- created
- mounted
- activited
- update
- beforeRouteUpdate
- metods
- filter
- computed
- watch

method 自定义方法命名

1、动宾短语(优:jumpPage、openCarInfoDialog)(差:go、nextPage、show、open、login)
2、ajax 方法以 get、post 开头,以 data 结尾(优:getListData、postFormData)(差:takeData、confirmData、getList、postForm)
3、事件方法以 on 开头(onTypeChange、onUsernameInput)
4、init、refresh 单词除外
5、尽量使用常用单词开头(set、get、open、close、jump)
6、驼峰命名(优:getListData)(差: get_list_data、getlistData)

data props 方法注意点

1、使用 data 里的变量时请先在 data 里面初始化
2、props 指定类型,也就是 type
3、props 改变父组件数据 基础类型用 $emit ,复杂类型直接改
4、ajax 请求数据用上 isLoading、isError 变量
5、不命名多余数据,现在是详情页、你的数据是 ajax 请求的,那就直接声明一个对象叫 d,而不是每个字段都声明
6、表单数据请包裹一层 form

vue编码规范

1、使用ES6风格编码源码
        定义变量使用let ,定义常量使用const
        使用export ,import 模块化
2、组件 props 原子化
        提供默认值
        使用 type 属性校验类型
        使用 props 之前先检查该 prop 是否存在
3、避免 this.$parent
4、谨慎使用 this.$refs
5、无需将 this 赋值给 component 变量
6、调试信息console.log() debugger 使用完及时删除
 

文字工具

转换工具

便民查询

开发工具

其它工具

随机推荐