Web前端-vue 开发命名规范

Posted 2021-09-19 MinggeQingchun

1、views 命名

views 文件夹下面是由 以页面为单位的 vue 文件 或者 模块文件夹 组成的

放在 src 目录之下，与 components、assets 同级

目录解析

目录/文件	说明
build	项目构建(webpack)相关代码
config	配置目录，包括端口号等。我们初学可以使用默认的。
node_modules	npm 加载的项目依赖模块
src	这里是我们要开发的目录，基本上要做的事情都在这个目录里。里面包含了几个目录及文件： assets: 放置一些图片，如logo等。 components: 目录里面放了一个组件文件，可以不用。 App.vue: 项目入口文件，我们也可以直接将组件写这里，而不使用 components 目录。 main.js: 项目的核心文件。
static	静态资源目录，如图片、字体等。
test	初始测试目录，可删除
.xxxx文件	这些是一些配置文件，包括语法配置，git配置等。
index.html	首页入口文件，你可以添加一些 meta 信息或统计代码啥的。
package.json	项目配置文件。
README.md	项目的说明文档，markdown 格式

打开 APP.vue 文件，代码如下（解释在注释中）：

src/APP.vue

<!-- 展示模板 -->
<template>
  <div id="app">
    <img src="./assets/logo.png">
    <hello></hello>
  </div>
</template>
 
<script>
// 导入组件
import Hello from './components/Hello'
 
export default {
  name: 'app',
  components: {
    Hello
  }
}
</script>
<!-- 样式代码 -->
<style>
#app {
  font-family: 'Avenir', Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}
</style>

2、views 下的文件夹命名

（1）views 下面的文件夹代表着模块的名字

（2）由名词组成（car、order、cart）

（3）单词只能有一个（good: car order cart）（bad: carInfo carpage）

（4）尽量是名词（good: car）（bad: greet good）

（5）以小写开头（good: car）（bad: Car）

3、views 下的 vue 文件命名

（1）views 下面的 vue 文件代表着页面的名字

（2）放在模块文件夹之下

（3）只有一个文件的情况下不会出现文件夹，而是直接放在 views 目录下面，如 Login Home

（4）尽量是名词

（5）大写开头，开头的单词就是所属模块名字（CarDetail、CarEdit、CarList）

（6）名字至少两个单词（good: CarDetail）（bad: Car）

（7）常用结尾单词有（Detail、Edit、List、Info、Report）

（8）以 Item 结尾的代表着组件（CarListItem、CarInfoItem）

4、vue 方法命名

vue 方法放置顺序

（1）components

（2）props

（3）data

（4）created

（5）mounted

（6）activited

（7）update

（8）beforeRouteUpdate

（9）metods

（10）filter

（11）computed

（12）watch

5、method 自定义方法命名

（1）动宾短语（good：jumpPage、openCarInfoDialog）（bad：go、nextPage、show、open、login）

（2）ajax 方法以 get、post 开头，以 data 结尾（good：getListData、postFormData）（bad：takeData、confirmData、getList、postForm）

（3）事件方法以 on 开头（onTypeChange、onUsernameInput）

（4）init、refresh 单词除外

（5）尽量使用常用单词开头（set、get、open、close、jump）

（6）驼峰命名（good: getListData）（bad: get_list_data、getlistData）

6、data props 方法注意点

（1）使用 data 里的变量时请先在 data 里面初始化

（2）props 指定类型，也就是 type

（3）props 改变父组件数据 基础类型用 $emit ，复杂类型直接改

（4）ajax 请求数据用上 isLoading、isError 变量

（5）不命名多余数据，现在是详情页、你的数据是 ajax 请求的，那就直接声明一个对象叫 d，而不是每个字段都声明

（6）表单数据请包裹一层 form

7、生命周期方法注意点

（1）不在 mounted、created 之类的方法写逻辑，取 ajax 数据，

（2）在 created 里面监听 Bus 事件