一、Vue前端开发有哪些规范
这次给大家带来Vue前端开发有哪些规范，Vue前端开发规范的注意事项有哪些，下面就是实战案例，一起来看一下。
基于Vue官方风格指南整理
一、强制1.组件名为多个单词
组件名应该始终是多个单词的，根组件 App除外。
正例：
export default{
name:'TodoItem',
//...
}
反例：
export default{
name:'Todo',
//...
}2.组件数据
组件的 data必须是一个函数。
当在组件中使用 data属性的时候(除了 new Vue外的任何地方)，它的值必须是返回一个对象的函数。
正例：
// In a.vue file
export default{
data(){
return{
foo:'bar'
}
}
}
//在一个 Vue的根实例上直接使用对象是可以的，
//因为只存在一个这样的实例。
new Vue({
data:{
foo:'bar'
}
})反例：
export default{
data:{
foo:'bar'
}
}3. Prop定义
Prop定义应该尽量详细。
在你提交的代码中，prop的定义应该尽量详细，至少需要指定其类型。
正例：
props:{
status: String
}
//更好的做法！
props:{
status:{
type: String,
required: true,
validator: function(value){
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value)!==-1
}
}
}反例：
//这样做只有开发原型系统时可以接受
props: ['status']4.为v-for设置键值
总是用 key配合 v-for。
在组件上_总是_必须用 key配合 v-for，以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为，比如动画中的对象固化(object constancy)，也是一种好的做法。
正例：
<ul>
<li
v-for="todo in todos"
:key="todo.id"
>
{{ todo.text}}
</li>
</ul>反例：
<ul>
<li v-for="todo in todos">
{{ todo.text}}
</li>
</ul>5.避免 v-if和 v-for用在一起
永远不要把 v-if和 v-for同时用在同一个元素上。
一般我们在两种常见的情况下会倾向于这样做：
为了过滤一个列表中的项目(比如 v-for="user in users" v-if="user.isActive")。在这种情形下，请将 users替换为一个计算属性(比如 activeUsers)，让其返回过滤后的列表。
为了避免渲染本应该被隐藏的列表(比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下，请将 v-if移动至容器元素上(比如 ul, ol)。
正例：
<ul v-if="shouldShowUsers">
<li
v-for="user in users"
:key="user.id"
>
{{ user.name}}
</li>
</ul>反例：
<ul>
<li
v-for="user in users"
v-if="shouldShowUsers"
:key="user.id"
>
{{ user.name}}
</li>
</ul>6.为组件样式设置作用域
对于应用来说，顶级 App组件和布局组件中的样式可以是全局的，但是其它所有组件都应该是有作用域的。
这条规则只和单文件组件有关。你不一定要使用 scoped特性。设置作用域也可以通过 CSS Modules，那是一个基于 class的类似 BEM的策略，当然你也可以使用其它的库或约定。
不管怎样，对于组件库，我们应该更倾向于选用基于 class的策略而不是 scoped特性。
这让覆写内部样式更容易：使用了常人可理解的 class名称且没有太高的选择器优先级，而且不太会导致冲突。
正例：
<template>
<button class="c-Button c-Button--close">X</button>
</template>
<!--使用 BEM约定-->
<style>
.c-Button{
border: none;
border-radius: 2px;
}
.c-Button--close{
background-color: red;
}
</style>反例：
<template>
<button class="btn btn-close">X</button>
</template>
<style>
.btn-close{
background-color: red;
}
</style>
<template>
<button class="button button-close">X</button>
</template>
<!--使用 `scoped`特性-->
<style scoped>
.button{
border: none;
border-radius: 2px;
}
.button-close{
background-color: red;
}
</style>二、强烈推荐（增强可读性）1.组件文件
只要有能够拼接文件的构建系统，就把每个组件单独分成文件。
当你需要编辑一个组件或查阅一个组件的用法时，可以更快速的找到它。
正例：
components/
|- TodoList.vue
|- TodoItem.vue反例：
V
ue.component('TodoList',{
//...
})
Vue.component('TodoItem',{
//...
})2.单文件组件文件的大小写
单文件组件的文件名应该要么始终是单词大写开头(PascalCase)
正例：
components/
|- MyComponent.vue反例：
components/
|- myComponent.vue
|- mycomponent.vue3.基础组件名
应用特定样式和约定的基础组件(也就是展示类的、无逻辑的或无状态的组件)应该全部以一个特定的前缀开头，比如 Base、App或 V。
正例：
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue反例：
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue4.单例组件名
只应该拥有单个活跃实例的组件应该以 The前缀命名，以示其唯一性。
这不意味着组件只可用于一个单页面，而是每个页面只使用一次。这些组件永远不接受任何 prop，因为它们是为你的应用定制的，而不是它们在你的应用中的上下文。如果你发现有必要添加 prop，那就表明这实际上是一个可复用的组件，只是目前在每个页面里只使用一次。
正例：
components/
|- TheHeading.vue
|- TheSidebar.vue反例：
components/
|- Heading.vue
|- MySidebar.vue5.紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义，这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。
正例：
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue反例：
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue6.组件名中的单词顺序
组件名应该以高级别的(通常是一般化描述的)单词开头，以描述性的修饰词结尾。
正例：
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue反例：
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue7.模板中的组件名大小写
总是 PascalCase的
正例：
<!--在单文件组件和字符串模板中-->
<MyComponent/>反例：
<!--在单文件组件和字符串模板中-->
<mycomponent/>
<!--在单文件组件和字符串模板中-->
<myComponent/>8.完整单词的组件名
组件名应该倾向于完整单词而不是缩写。
正例：
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue反例：
components/
|- SdSettings.vue
|- UProfOpts.vue9.多个特性的元素
多个特性的元素应该分多行撰写，每个特性一行。
正例：
<img
src=""
alt="Vue Logo"
>
<MyComponent
foo="a"
bar="b"
baz="c"
/>反例：
<img src="" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>10.模板中简单的表达式
组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。
复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么，而非如何计算那个值。而且计算属性和方法使得代码可以重用。
正例：
<!--在模板中-->
{{ normalizedFullName}}
//复杂表达式已经移入一个计算属性
computed:{
normalizedFullName: function(){
return this.fullName.split('').map(function(word){
return word[0].toUpperCase()+ word.slice(1)
}).join('')
}
}反例：
{{
fullName.split('').map(function(word){
return word[0].toUpperCase()+ word.slice(1)
}).join('')
}}11.简单的计算属性
正例：
computed:{
basePrice: function(){
return this.manufactureCost/(1- this.profitMargin)
},
discount: function(){
return this.basePrice*(this.discountPercent|| 0)
},
finalPrice: function(){
return this.basePrice- this.discount
}
}反例：
computed:{
price: function(){
var basePrice= this.manufactureCost/(1- this.profitMargin)
return(
basePrice-
basePrice*(this.discountPercent|| 0)
)
}
}12.带引号的特性值
非空 HTML特性值应该始终带引号(单引号或双引号，选你 JS里不用的那个)。
在 HTML中不带空格的特性值是可以没有引号的，但这样做常常导致带空格的特征值被回避，导致其可读性变差。
正例：
<AppSidebar:style="{ width: sidebarWidth+'px'}">反例：
<AppSidebar:style={width:sidebarWidth+'px'}>13.指令缩写
都用指令缩写(用:表示 v-bind:和用@表示 v-on:)
正例：
<input
@input="onInput"
@focus="onFocus"
>反例：
<input
v-bind:value="newTodoText"
:placeholder="newTodoInstructions"
>三、推荐1.单文件组件的顶级元素的顺序
单文件组件应该总是让<script>、<template>和<style>标签的顺序保持一致。且<style>要放在最后，因为另外两个标签至少要有一个。
正例：
<!-- ComponentA.vue-->
<template>...</template>
<script>/*...*/</script>
<style>/*...*/</style>四、谨慎使用(有潜在危险的模式)1.没有在 v-if/v-if-else/v-else中使用 key
如果一组 v-if+ v-else的元素类型相同，最好使用 key(比如两个<p>元素)。
正例：
<p
v-if="error"
key="search-status"
>
错误：{{ error}}
</p>
<p
v-else
key="search-results"
>
{{ results}}
</p>
反例：
<p v-if="error">
错误：{{ error}}
</p>
<p v-else>
{{ results}}
</p>2. scoped中的元素选择器
元素选择器应该避免在 scoped中出现。
在 scoped样式中，类选择器比元素选择器更好，因为大量使用元素选择器是很慢的。
正例：
<template>
<button class="btn btn-close">X</button>
</template>
<style scoped>
.btn-close{
background-color: red;
}
</style>反例：
<template>
<button>X</button>
</template>
<style scoped>
button{
background-color: red;
}
</style>3.隐性的父子组件通信
应该优先通过 prop和事件进行父子组件之间的通信，而不是 this.$parent或改变 prop。
正例：
Vue.component('TodoItem',{
props:{
todo:{
type: Object,
required: true
}
},
template: `
<input
:value="todo.text"
@input="$emit('input',$event.target.value)"
>
`
})反例：
Vue.component('TodoItem',{
props:{
todo:{
type: Object,
required: true
}
},
methods:{
removeTodo(){
var vm= this
vm.$parent.todos= vm.$parent.todos.filter(function(todo){
return todo.id!== vm.todo.id
})
}
},
template: `
<span>
{{ todo.text}}
<button@click="removeTodo">
X
</button>
</span>
`
})4.非 Flux的全局状态管理
应该优先通过 Vuex管理全局状态，而不是通过 this.$root或一个全局事件总线。
正例：
// store/modules/todos.js
export default{
state:{
list: []
},
mutations:{
REMOVE_TODO(state, todoId){
state.list= state.list.filter(todo=> todo.id!== todoId)
}
},
actions:{
remov
二、前端规范一***命名规范***
前端规范一（命名规范）
1、小驼峰命名法（lowerCamelCase）：第一个单词以小写字母开始，第二个单词的首字母大写，例如：firstName、lastName。
2、大驼峰命名法（CamelCase）：每一个单词的首字母都采用大写字母，例如：FirstName、LastName。
3、下划线命名法（snake_case）：下划线命名法也叫蛇形法，全由小写字母和下划线组成，在两个单词之间用下滑线连接。例如：first_name。
4、中划线命名法（kebab-case）：中划线命名法也叫串式命名法，各个单词之间通过下划线“-”连接。例如：first-name。
强制使用：中划线命名法
命名规则：1、文件名不得含有空格
2、文件名建议只使用小写字母，不使用大写字母
3、文件名包含多个单词时，单词之间建议连词线(-)分隔
4、有复数结构式，要使用复数
示例：login、 error-page、 icons
强制使用：全部大写字母
为了醒目，某些说明文件的文件名，可以使用大写字母
示例：README
补充说明: README标准
◎项目简介。
◎注意事项。
◎线上的示例地址（测试、正式）。
◎支持运行的环境。
◎必要的依赖准备，以及如何搭建。
◎项目的安装指南。
◎相关的文档链接。
◎相关人员的联系方式。
README.md示例：
强制使用：小驼峰命名法
命名规则：前缀为动词，见名知意
1、onXxx监听事件的回调
2、handleXxx处理事件
3、getXxx获取某个值
4、setXxx设置某个值
常见场景：
a、事件处理：
(1).事件主动监听采用 onXxx,被动处理使用handleXxx
示例：onXxxSubmit:'提交表单'
handleXxxSizeChange:'处理分页页数改变'
handleXxxPageChange:'处理分页每页大小改变'
onXxxKeydown:'按下键'
(2).其他命名：元素+click、元素+change、select+范围
示例：selectAllXxx:'选择所有'
xxxCellClick:'当某个单元格被点击时会触发该事件'
xxxSortChange:'当表格的排序条件发生变化的时候会触发该事件'
b、增删改查处理：
增: addXxx添加子项
createXxx创建大项
删: deleteXxx真删除
removeXxx伪删除
改：updateXxx
查: getXxx获取原始数据需要修改
fetchXxx原始数据
示例：getUserList:'获取用户列表', fetchToken:'取得Token', deleteUser:'删除用户', removeTag:'移除标签', updateUserInfo:'更新用户信息', addUser:'添加用户', createAccount:'创建账户'
c、API接口函数：
get: getXxxApi
post: postXxxApi
patch: patchXxxApi
delect: delectXxxApi
域名：xxxUrl
一般属性变量强制使用：小驼峰命名法
1、布尔值
命名规则：前缀为判断性动词
hasXxx判断是否含有某个值。true：含有此值； false：不含有此值
isXxx判断是否为某个值。true：为某个值； false：不为某个值
示例：isShow:'是否显示', isLoading:'是否处于加载中'， hasToken:'是否包含Token',
2、数组命名
命名规则：使用名词+List组合
示例: userList:'用户列表'
3、私有属性变量
命名规则：前缀为下划线(_)后面和变量命名一样。
4、枚举变量\textcolor{red}{强制使用：大驼峰命名法}
枚举的属性使用全大写字母，单词间用下划线隔开。
示例：let TargetState={ READING: 1, READED: 2, APPLIED: 3, READY: 4};
5、常量：强制使用：使用全大写字母，单词间用下划线隔开
强制使用：大驼峰命名法
命名规则：可参考vue官网风格指南
例如： 1、按照功能来命名
2、应用特定样式和约定的基础组件(也就是展示类的、无逻辑的或无状态的组件)应该全部以一个特定的前缀开头，比如 Base、App或 V。
3、组件名应该以高级别的(通常是一般化描述的)单词开头，以描述性的修饰词结尾。
示例：components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
强制使用:中划线命名法
命名规则：
1.class、id、标签、属性的命名应该尽量精短、明确，必须以字母开头命名，且全部字母为小写，单词之间统一使用中划线“-”连接
2.class必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。
3.元素 id必须保证页面唯一。
4.禁止创建无样式信息的 class
示例：
1、尽量不要缩写、简写的单词。除了 template=> tmp、message=> msg、image=> img、property=> prop这些单词已经被公认的缩写
2、可读性强的命名优先于简短的命名
3、命名长度最好在 20个字符以内，避免多长带来的阅读不便
4、命名要有具体的含义，避免使用一些泛指和无具体含义的词
5、不要使用拼音，更不要使用中文
6、正则表达式用 Exp结尾
7、ref：使用Ref结尾
三、Web前端工程师要知道的JavaScript变量命名规范
今天小编要跟大家分享的文章是关于Web前端工程师要知道的JavaScript变量命名规范，正在从事Web前端工作的小伙伴们来和小编一起看一看吧，希望本篇文章能够对大家有所帮助。
JavaScript变量命名规范：只能由英语字母、数字、下划线、美元符号$构成，且不能以数字开头，并且不能是JavaScript保留字。
下列都是非常正确的变量命名：
varhaha=250;
varxixi=300;
vara1=400;
vara2=400;
varabc_123=400;
var$abc=999;
var$o0_0o$=888;
var$=1000;
var_=2000;
var________=3000;
下列都是错误的命名：
vara-1=1000;//不能有怪异符号
vara@=2000;//不能有怪异符号
var2year=3000;//不能以数字开头
vara￥=4000;//不能有怪异符号
vara*#$#$@=5000;//不能有怪异符号
varab=300;//不能有空格
下列的单词，叫做保留字，就是说不允许当做变量名
abstract、boolean、byte、char、class、const、debugger、double、enum、export、extends、final、float、goto
implements、import、int、interface、long、native、package、private、protected、public、short、static、super、synchronized、throws、transient、volatile
需要注意大写字母是可以使用的，并且大小写敏感。也就是说A和a是两个变量。
1varA=250;
2vara=888;
以上就是小编今天为大家分享的关于Web前端工程师要知道的JavaScript变量命名规范的文章，希望本篇文章能够对正在从事Web前端工作的小伙伴们有所帮助。想要了解更多Web前端知识记得关注北大青鸟Web培训官网。最后祝愿小伙伴们工作顺利!