Vue前端代码风格指南超级详细

本文仅作日常项目开发中的知识补充，不必按顺序阅读，如果已经知悉，请跳过。

一、命名规范

现有常用的命名规范：

 camelCase(小驼峰——首字母小写)
PsscalCase(大驼峰——首字母大写)
kebab-case (短横线连接式)
Snake(下划线连接式)

1.1 项目文件命名

1.1.1 项目名

全部采用小写方式， 以短横线分隔。如：my-project

1.1.2 目录名

全部采用小写方式， 以短横线分隔，有复数结构时，要采用复数命名法。如：assets、components、directives、mixins、utils、views。

项目结构示例

my-project-name/
|- BuildScript
// 流水线部署文件目录
|- docs
// 项目的细化文档目录（可选）
|- nginx
// 部署在容器上前端项目 nginx 代理文件目录
|- node_modules
// 下载的依赖包
|- public
// 静态页面目录
|- index.html // 项目入口
|- src
// 源码目录
|- api
// http 请求目录
|- assets
// 静态资源目录，这里的资源会被wabpack构建
|- icon
// icon 存放目录
|- img
// 图片存放目录
|- js
// 公共 js 文件目录
|- scss
// 公共样式 scss 存放目录
|- frame.scss
// 入口文件
|- global.scss
// 公共样式
|- reset.scss
// 重置样式
|- components
// 组件
|- plugins
// 插件
|- router
// 路由
|- routes
// 详细的路由拆分目录（可选）
|- index.js
|- store
// 全局状态管理
|- utils
// 工具存放目录
|- request.js // 公共请求工具
|- views
// 页面存放目录
|- App.vue
// 根组件
|- main.js
// 入口文件
|- tests
// 测试用例
|- .browserslistrc// 浏览器兼容配置文件
|- .editorconfig
// 编辑器配置文件
|- .eslintignore
// eslint 忽略规则
|- .eslintrc.js
// eslint 规则
|- .gitignore
// git 忽略规则
|- babel.config.js // babel 规则
|- Dockerfile // Docker 部署文件
|- jest.config.js
|- package-lock.json
|- package.json // 依赖
|- README.md // 项目 README
|- vue.config.js // webpack 配置

1.1.3 图像文件名

全部采用小写方式， 优先选择单个单词命名，多个单词命名以下划线分隔

banner.gif
menu_aboutus.gif
logo_police.gif
logo_national.gif
pic_people.jpg

1.1.4 HTML文件命名

全部采用小写方式， 优先选择单个单词命名，多个单词命名以下划线分隔

|- error_report.html
|- success_report.html

1.1.5 CSS文件命名

全部采用小写方式， 优先选择单个单词命名，多个单词命名以短横线分隔

|- error_report.html
|- success_report.html

1.1.6 JavaScript文件命名

全部采用小写方式， 优先选择单个单词命名，多个单词命名以短横线分隔

|- index.js
|- plugin.js
|- util.js
|- date-util.js
|- account-model.js
|- collapse-transition.js

以上规则简记为：静态文件下划线分隔，编译文件短横线分隔

1.2 Vue 组件命名

1.2.1 单文件组件名

文件扩展名为 .vue 的 single-file components (单文件组件)。单文件组件名应该始终是单词大写开头 (PascalCase)。

components/
|- MyComponent.vue

1.2.2 单例组件名

只拥有单个活跃实例的组件应该以The 前缀命名，以示其唯一性。

components/
|- TheHeading.vue
|- TheSidebar.vue

1.2.3 基础组件名

基础组件：既不包含业务的通用组件，比如 日期选择器、模态框、有数据校验功能的输入框 等。这类组件作为项目的基础控件，会被大量使用，因此组件的 API进行过高强度的抽象，可以通过不同配置实现不同的功能。基础组件在一个页面内可使用多次，在不同页面内也可复用，是高可复用组件

全部以Base 前缀命名

components/
|- BaseTable.vue
|- BaseIcon.vue

1.2.4 业务组件

业务组件：在业务中被多个页面复用的组件，与基础组件的区别是，业务组件只在当前项目中会用到，不具有通用性，会包含一些业务，比如数据请求；而基础组件不含业务，在任何项目中都可以使用，功能单一。

掺杂了复杂业务的组件（拥有自身data、prop的相关处理）即业务组件应该以 Custom 前缀命名。

components/
|- CustomCard.vue

1.2.5 紧密耦合的组件名

和父组件紧密耦合的子组件应该以父组件名作为前缀命名。 因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。

components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue

1.2.6 组件名中单词顺序

组件名应该以动词开头，以描述性的修饰词结尾。 因为编辑器通常会按字母顺序组织文件，所以现在组件之间的重要关系一目了然。如下组件主要是用于搜索和设置功能。

components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue

1.2.7 完整单词的组件名

不常用的缩写应该避免

1.3 代码参数命名

1.3.1 name

组件名应该始终是多个单词，应该始终是 PascalCase 的。 根组件 App 以及 、 之类的 Vue 内置组件除外。这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

export default {
name: 'ToDoList',
// ...
}

1.3.2 prop

在声明 prop 的时候，其命名应该始终使用 camelCase，而在模板和 JSX 中应该始终使用 kebab-case。我们单纯的遵循每个语言的约定，在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case

<WelcomeMessage greeting-text="hi"/>

export default {
name: 'MyComponent',
// ...
props: {
greetingText: {
type: String,
required: true,
validator: function (value) {
return ['syncing', 'synced',].indexOf(value) !== -1
}
}
}
}

1.3.3 router

Vue Router Path 命名采用 kebab-case 格式。 用 Snake（如：/user_info）或 camelCase（如：/userInfo)的单词会被当成一个单词，搜索引擎无法区分语义

// bad
{
path: '/user_info', // user_info 当成一个单词
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用户',
desc: ''
}
},
// good
{
path: '/user-info', // 能解析成 user info
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用户',
desc: ''
}
},

1.3.4 模板中组件

**在单文件组件和字符串模板中组件名应该总是 PascalCase ，但是在 DOM 模板中总是 kebab-case **

// 在字符串模板中
`<MyComponent/>`

<!-- 在单文件组件中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>

1.3.5 自闭合组件

在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合，但在 DOM 模板里不要这样做。

// 在字符串模板中
`<MyComponent/>`

<!-- 在单文件组件中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>

1.3.6 变量

• 命名方法：camelCase
• 命名规范：类型 + 对象描述或属性的方式

// bad
var getTitle = "LoginTable"
// good
let tableTitle = "LoginTable"
let mySchool = "我的学校"

1.3.7 常量

• 命名方法：全部大写下划线分割
• 命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词

const MAX_COUNT = 10
const URL = 'http://test.host.com'

1.3.8 方法

• 命名方法：camelCase
• 命名规范：统一使用动词或者动词 + 名词形式

// 1、普通情况下，使用动词 + 名词形式
// bad
go、nextPage、show、open、login
// good
jumpPage、openCarInfoDialog
// 2、请求数据方法，以 data 结尾
// bad
takeData、confirmData、getList、postForm
// good
getListData、postFormData
// 3、单个动词的

1.3.9 自定义事件

自定义事件应始终使用 kebab-case（短横线连接） 的事件名

<MyComponent @my-event="handleDoSomething" />
this.$emit('my-event')

<MyComponent @my-event="handleDoSomething" />

建议:除了多单词事件名使用 kebab-case 的情况下，命名还需遵守为 on + 动词 的形式

<!-- 父组件 -->
<div
@on-search="handleSearch"
@on-clear="handleClear">
</div>

// 子组件
export default {
methods: {
handleTriggerItem () {
this.$emit('on-clear')
}
}
}

1.3.10 事件方法

• 命名方法：camelCase
• 命名规范：handle + 名称（可选）+ 动词

<template>
<div
@click.native.stop="handleItemClick()"
@mouseenter.native.stop="handleItemHover()">
</div>
</template>
<script>
export default {
methods: {
handleItemClick () {
//...
},
handleItemHover () {
//...
}
}
}
</script>

二、代码规范

2.1 Vue

2.1.1 代码结构

<template>
<div id="my-component">
<DemoComponent />
</div>
</template>
<script>
import DemoComponent from '../components/DemoComponent'
export default {
name: 'MyComponent',
components: {
DemoComponent
},
mixins: [],
props: {},
data () {
return {}
},
computed: {},
watch: {}
created () {},
mounted () {},
destroyed () {},
methods: {},
}
</script>
<style lang="scss" scoped>
#my-component {
}
</style>

2.1.2 data

组件的 data 必须是一个函数

export default {
data () {
return {
foo: 'bar'
}
}
}

2.1.3 prop

Prop 定义应该尽量详细，并配有一定注释，如果格式较为复杂，建议增加数据结构demo的注释

export default {
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
}

2.1.4 computed

复杂计算属性分割为尽可能多的更简单的属性——计算属性元件 单一原则的计算属性减少了信息使用时的假设性限制，所以需求变更时也用不着那么多重构

// bad
computed: {
price: function () {
var basePrice = this.manufactureCost / (1 - this.profitMargin)
return (
basePrice -
basePrice * (this.discountPercent || 0)
)
}
}
// good
computed: {
basePrice: function () {
return this.manufactureCost / (1 - this.profitMargin)
},
discount: function () {
return this.basePrice * (this.discountPercent || 0)
},
finalPrice: function () {
return this.basePrice - this.discount
}
}

2.1.5 为 v-for 设置键值

在组件上必须用 key 搭配v-for

<ul>
<li
v-for="todo in todos"
:key="todo.id">
{{ todo.text }}
</li>
</ul>

2.1.6 v-if 和 v-for 互斥

不要把 v-if 和 v-for 同时用在同一个元素上,常见的作法如下两种

• 为了过滤一个列表中的项目 (比如 v-for="user in users" v-if="user.isActive")。在这种情形下，请将 users 替换为一个计算属性 (比如 activeUsers)，让其返回过滤后的列表。

computed: {
activeUsers: function () {
return this.users.filter((user) => {
return user.isActive
})
}
}

<ul>
<li
v-for="user in activeUsers"
:key="user.id">
{{ user.name }}
</li>
</ul>

• 为了避免渲染本应该被隐藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下，请将 v-if 移动至容器元素上 (比如ul, ol)

<!-- bad -->
<ul>
<li
v-for="user in users"
v-if="shouldShowUsers"
:key="user.id">
{{ user.name }}
</li>
</ul>
<!-- good -->
<ul v-if="shouldShowUsers">
<li
v-for="user in users"
:key="user.id">
{{ user.name }}
</li>
</ul>

2.1.7 多个 attribute 的元素

多个 attribute（属性） 的元素应该分多行撰写，每个 attribute 一行

<!-- bad -->
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
<!-- good -->
<img
src="https://vuejs.org/images/logo.png"
alt="Vue Logo">
<MyComponent
foo="a"
bar="b"
baz="c"/>

2.1.8 模板中只包含简单的表达式

组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法
复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么，而非如何计算那个值。而且计算属性和方法使得代码可以重用

// bad
{{
fullName.split(' ').map((word) => {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}

更好的做法

<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {
normalizedFullName: function () {
return this.fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}
}

2.1.9 带引号的 attribute 值

非空 HTML 特性值应该始终带双引号

<!-- bad -->
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
<!-- good -->
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">

2.1.10 指令缩写

• 用 : 表示 v-bind:
• 用 @ 表示 v-on:
• 用 # 表示 v-slot:

<input
:value="newTodoText"
:placeholder="newTodoInstructions">
<input
@input="onInput"
@focus="onFocus">
<template #header>
<h1>Here might be a page title</h1>
</template>
<template #footer>
<p>Here's some contact info</p>
</template>

2.2 HTML

2.2.1 文件模板

H5文件模板：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>HTML5标准模版</title>
</head>
<body>
</body>
</html>

移动端：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport"
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, shrink-to-fit=no">
<meta name="format-detection" content="telephone=no">
<title>移动端HTML模版</title>
<!-- S DNS预解析 -->
<link rel="dns-prefetch" href="">
<!-- E DNS预解析 -->
<!-- S 线上样式页面片，开发请直接取消注释引用 -->
<!-- #include virtual="" -->
<!-- E 线上样式页面片 -->
<!-- S 本地调试，根据开发模式选择调试方式，请开发删除 -->
<link rel="stylesheet" href="css/index.css">
<!-- /本地调试方式 -->
<link rel="stylesheet" href="http://srcPath/index.css">
<!-- /开发机调试方式 -->
<!-- E 本地调试 -->
</head>
<body>
</body>
</html>

PC端：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="keywords" content="your keywords">
<meta name="description" content="your description">
<meta name="author" content="author,email address">
<meta name="robots" content="index,follow">
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
<meta name="renderer" content="ie-stand">
<title>PC端HTML模版</title>
<!-- S DNS预解析 -->
<link rel="dns-prefetch" href="">
<!-- E DNS预解析 -->
<!-- S 线上样式页面片，开发请直接取消注释引用 -->
<!-- #include virtual="" -->
<!-- E 线上样式页面片 -->
<!-- S 本地调试，根据开发模式选择调试方式，请开发删除 -->
<link rel="stylesheet" href="css/index.css">
<!-- /本地调试方式 -->
<link rel="stylesheet" href="http://srcPath/index.css">
<!-- /开发机调试方式 -->
<!-- E 本地调试 -->
</head>
<body>
</body>
</html>

2.2.2 元素及标签闭合

HTML 元素共有以下5种：

• 空元素：area、base、br、col、command、embed、hr、img、input、keygen、link、meta、param、source、track、wbr
• 原始文本元素：script、style
• RCDATA 元素：textarea、title
• 外来元素：来自 MathML 命名空间和 SVG 命名空间的元素
• 常规元素：其他 HTML 允许的元素都称为常规元素

为了能让浏览器更好的解析代码以及能让代码具有更好的可读性，有如下约定：

所有具有开始标签和结束标签的元素都要写上起止标签，某些允许省略开始标签或和束标签的元素亦都要写上。
空元素标签都不加 “/” 字符。

<!-- good -->
<div>
<h1>我是h1标题</h1>
<p>我是一段文字，我有始有终，浏览器能正确解析</p>
</div>
<br data-tomark-pass>
<!-- bad -->
<div>
<h1>我是h1标题</h1>
<p>我是一段文字，我有始无终，浏览器亦能正确解析
</div>
<br/>

2.2.3 代码嵌套

每个块状元素独立一行，内联元素可选

<!-- bad -->
<div>
<h1></h1><p></p>
</div>
<p>
<span></span>
<span></span>
</p>
<!-- good -->
<div>
<h1></h1>
<p></p>
</div>
<p><span></span><span></span></p>

段落元素与标题元素只能嵌套内联元素：

<!-- bad -->
<h1><div></div></h1>
<p><div></div><div></div></p>
<!-- good -->
<h1><span></span></h1>
<p><span></span><span></span></p>

2.3 CSS

2.3.1 样式文件

样式文件必须写上 @charset 规则，并且一定要在样式文件的第一行首个字符位置开始写，编码名用 “UTF-8”

/********************推荐*******************/
/*******************************************/
@charset "UTF-8";
.jdc {}
/*******************不推荐******************/
/*******************************************/
/* @charset规则没有用小写 */
@CHARSET "UTF-8";
.jdc {}
/* 无@charset规则 */
.jdc {}

2.3.2 代码格式化

样式书写一般有两种：一种是紧凑格式 （Compact），一种是展开格式（Expanded），推荐展开格式

/******************推荐*************/
/***********************************/
.jdc {
display: block;
width: 50px;
}
/****************不推荐*************/
/***********************************/
.jdc { display: block; width: 50px;}

2.3.3 代码大小写

样式选择器，属性名，属性值关键字全部使用小写字母书写，属性字符串允许使用大小写。

2.3.4 代码易读性

样式选择器，属性名，属性值关键字全部使用小写字母书写，属性字符串允许使用大小写。

• 左括号与类名之间一个空格，冒号与属性值之间一个空格

.jdc {
width: 100%;
}

• 逗号分隔的取值，逗号之后一个空格

.jdc {
box-shadow: 1px 1px 1px #333, 2px 2px 2px #ccc;
}

• 为单个 CSS 选择器或新声明开启新行

.jdc, .jdc_logo, .jdc_hd {
color: #ff0;
}
.nav{
color: #fff;
}

• 颜色值 rgb() rgba() hsl() hsla() rect() 中不需有空格，且取值不要带有不必要的 0

.jdc {
color: rgba(255,255,255,.5);
}

• 属性值十六进制数值能用简写的尽量用简写

.jdc {
color: #fff;
}

• 不要为 0 指明单位

.jdc {
margin: 0 10px;
}

2.3.5 属性值引号

CSS 属性值需要用到引号时，统一使用单引号

/******************推荐*************/
/***********************************/
.jdc {
font-family: 'Hiragino Sans GB';
}
/****************不推荐*************/
/***********************************/
.jdc {
font-family: "Hiragino Sans GB";
}

2.3.6 属性书写建议

建议遵循以下顺序：

1. 布局定位属性：display / position / float / clear / visibility / overflow
2. 自身属性：width / height / margin / padding / border / background
3. 文本属性：color / font / text-decoration / text-align / vertical-align / white- space / break-word
4. 其他属性（CSS3）：content / cursor / border-radius / box-shadow / text-shadow / background: linear-gradient

.jdc {
display: block;
position: relative;
float: left;
width: 100px;
height: 100px;
margin: 0 10px;
padding: 20px 0;
font-family: Arial, 'Helvetica Neue', Helvetica, sans-serif;
color: #333;
background: rgba(0,0,0,.5);
-webkit-border-radius: 10px;
-moz-border-radius: 10px;
-o-border-radius: 10px;
-ms-border-radius: 10px;
border-radius: 10px;
}

2.3.7 CSS3浏览器私有前缀

CSS3 浏览器私有前缀在前，标准前缀在后

.jdc {
-webkit-border-radius: 10px;
-moz-border-radius: 10px;
-o-border-radius: 10px;
-ms-border-radius: 10px;
border-radius: 10px;
}

2.4 JavaScript

2.4.1 单行代码块

在单行代码块中使用空格

// 不推荐
function foo () {return true}
if (foo) {bar = 0}
// 推荐
function foo () { return true }
if (foo) { bar = 0 }

2.4.2 大括号风格

在编程过程中，大括号风格与缩进风格紧密联系，用来描述大括号相对代码块位置的方法有很多。在 JavaScript 中，主要有三种风格，如下

if (foo) {
bar()
} else {
baz()
}

if (foo) {
bar()
}
else {
baz()
}

if (foo)
{
bar()
}
else
{
baz()
}

2.4.3 代码中的空格

• 约定在逗号后面使用空格

var foo = 1, bar = 2

• 对象字面量的键和值之间不能存在空格，且要求对象字面量的冒号和值之间存在一个空格

var obj = { 'foo': 'haha' }

• 代码块前添加空格

if (a) {
b()
}
function a () {}

• 函数声明括号前要加空格

// 推荐
function func (x) {
// ...
}
// 不推荐
function func(x) {
// ...
}

• 函数调用时，禁止使用空格

// 推荐
fn()
// 不推荐
fn ()
fn
()

• 操作符前后都需要添加空格

// 推荐
var sum = 1 + 2
// 不推荐
var sum = 1+2

3 注释规范

注释的目的：

• 提高代码的可读性，从而提高代码的可维护性
  注释的原则：

• 如无必要，勿增注释 ( As short as possible )

• 如有必要，尽量详尽 ( As long as necessary )

3.1 HTML文件注释

3.1.1 单行注释

用于简单的描述，如某些状态描述、属性描述等

注释内容前后各一个空格字符，注释位于要注释代码的上面，单独占一行

<!-- 推荐注释 -->
<div>...</div>
<div>...</div><!-- 不推荐注释 -->
<!--不推荐注释-->
<div>...</div>

3.1.2 模块注释

用于描述模块的名称以及模块开始与结束的位置

注释内容前后各一个空格字符， <!-- S Comment Text -->表示模块开始， <!-- E Comment Text -->表示模块结束，模块与模块之间相隔一行

推荐：

<!-- S Comment Text A -->
<div class="mod_a">
...
</div>
<!-- E Comment Text A -->
<!-- S Comment Text B -->
<div class="mod_b">
...
</div>
<!-- E Comment Text B -->

不推荐：

<!-- S Comment Text A -->
<div class="mod_a">
...
</div>
<!-- E Comment Text A -->
<!-- S Comment Text B -->
<div class="mod_b">
...
</div>
<!-- E Comment Text B -->

3.1.3 嵌套模块注释

当模块注释内再出现模块注释的时候，为了突出主要模块，嵌套模块不再使用

<!-- S Comment Text -->
<!-- E Comment Text -->

改用

<!-- /Comment Text -->

注释写在模块结尾标签底部，单独一行

<!-- S Comment Text A -->
<div class="mod_a">
<div class="mod_b">
...
</div>
<!-- /子模块A -->
<div class="mod_c">
...
</div>
<!-- /子模块B -->
</div>
<!-- E Comment Text A -->

3.2 CSS 文件注释

3.2.1 单行注释

注释内容第一个字符和最后一个字符都是一个空格字符，单独占一行，行与行之间相隔一行

推荐：

/* Comment Text */
.jdc {}
/* Comment Text */
.jdc {}

不推荐：

/*Comment Text*/
.jdc {
display: block;
}
.jdc {
display: block;/*Comment Text*/
}

3.2.2 模块注释

注释内容第一个字符和最后一个字符都是一个空格字符，/* 与 模块信息描述占一行，多个横线分隔符 - 与 */ 占一行，行与行之间相隔两行
推荐：

/* Module A
---------------------------------------------------------------- */
.mod_a {}
/* Module B
---------------------------------------------------------------- */
.mod_b {}

不推荐：

/* Module A ---------------------------------------------------- */
.mod_a {}
/* Module B ---------------------------------------------------- */
.mod_b {}

3.2.3 文件注释

样式文件编码声明 @charset 语句下面注明页面名称、作者、创建日期等信息

@charset "UTF-8";
/**
* @desc File Info
* @author Author Name
* @date 2021-11-03
*/

3.3 JavaScript 文件注释

3.1.1 单行注释

单行注释使用//，注释应单独一行写在被注释对象的上方，不要追加在某条语句的后面

推荐：

// is current tab
const active = true

不推荐：

const active = true // is current tab

如果你已经写了语句后的注释，保持脚本内的代码风格统一
注释行的上方需要有一个空行（除非注释行上方是一个块的顶部），以增加可读性

function getType () {
console.log('fetching type...')
// 注释行的上方需要有一个空行
const type = this.type || 'no type'
return type
}
// 注释行上面是一个块的顶部时不需要空行
function getType () {
// set the default type to 'no type'
const type = this.type || 'no type'
return type
}

3.3.2 多行注释

多行注释使用/** ... */，而不是多行的 //

/**
* make() returns a new element
* based on the passed-in tag name
*/
function make (tag) {
// ...
return element
}

3.3.3 注释空格

注释内容和注释符之间需要有一个空格，以增加可读性

// is current tab
const active = true
/**
* make() returns a new element
* based on the passed-in tag name
*/
function make(tag) {
// ...
return element
}

3.3.4 特殊标记

有时我们发现某个可能的 bug，但因为一些原因还没法修复；或者某个地方还有一些待完成的功能，这时我们需要使用相应的特殊标记注释来告知未来的自己或合作者。常用的特殊标记有两种：

• // FIXME : 说明问题是什么
• // TODO : 说明还要做什么或者问题的解决方案

class Calculator extends Abacus {
constructor () {
super ()
// FIXME: shouldn’t use a global here
total = 0
// TODO: total should be configurable by an options param
this.total = 0
}
}

3.3.5 文档类注释

文档类注释，如函数、类、文件、事件等；都使用 jsdoc 规范

/**
* Book类，代表一个书本.
* @constructor
* @param {string} title - 书本的标题.
* @param {string} author - 书本的作者.
*/
function Book (title, author) {
this.title = title
this.author = author
}
Book.prototype = {
/**
* 获取书本的标题
* @returns {string|*}
*/
getTitle: function () {
return this.title
},
/**
* 设置书本的页数
* @param pageNum {number} 页数
*/
setPageNum: function (pageNum) {
this.pageNum=pageNum
}
}

3.3.6 注释工具

ESLint 是当下最流行的 JS 代码检查工具，ESLint 中有一些注释相关的规则，用户可选择开启（项目中尽量开启）

最后

以上就是土豪缘分为你收集整理的Vue前端代码风格指南超级详细的全部内容，希望文章能够帮你解决Vue前端代码风格指南超级详细所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。