最新前端Vue代码风格指南大全

2.1.2 data

组件的 data 必须是一个函数。

// In a .vue file

export default {

data () {

return {

foo: ‘bar’

}

}

}

2.1.3 prop

Prop 定义应该尽量详细。

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，以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为，比如动画中的对象固化 (object constancy)[2]。

v-for=“todo in todos”

:key=“todo.id”>

{{ todo.text }}

2.1.6 v-if 和 v-for 互斥

永远不要把 v-if 和 v-for 同时用在同一个元素上。

v-for=“user in users”

v-if=“shouldShowUsers”

:key=“user.id”>

{{ user.name }}

一般我们在两种常见的情况下会倾向于这样做：

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

computed: {

activeUsers: function () {

return this.users.filter((user) => {

return user.isActive

})

}

}

v-for=“user in activeUsers”

:key=“user.id”>

{{ user.name }}

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

v-for=“user in users”

v-if=“shouldShowUsers”

:key=“user.id”>

{{ user.name }}

v-for=“user in users”

:key=“user.id”>

{{ user.name }}

2.1.7 多个 attribute 的元素

多个 attribute 的元素应该分多行撰写，每个 attribute 一行。

<img src=“https://vuejs.org/images/logo.png” alt=“Vue Logo”>

<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 特性值应该始终带双引号。

复制代码

2.1.10 指令缩写

• 用 : 表示 v-bind:

• 用 @ 表示 v-on:

• 用 # 表示 v-slot:

<input

:value=“newTodoText”

:placeholder=“newTodoInstructions”>

<input

@input=“onInput”

@focus=“onFocus”>

<template #header>

Here might be a page title

<template #footer>

Here’s some contact info

2.2 HTML

2.2.1 文件模板

HTML5 文件模板：

移动端：

<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”>

PC 端：

<meta name=“keywords” content=“your keywords”>

<meta name=“description” content=“your description”>

<meta name=“author” content=“author,email address”>

<meta http-equiv=“X-UA-Compatible” content=“IE=Edge,chrome=1”>

复制代码

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 允许的元素都称为常规元素

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

• 所有具有开始标签和结束标签的元素都要写上起止标签，某些允许省略开始标签或和束标签的元素亦都要写上。

• 空元素标签都不加 “/” 字符。

我是h1标题

我是一段文字，我有始有终，浏览器能正确解析

我是h1标题

我是一段文字，我有始无终，浏览器亦能正确解析

2.2.3 代码嵌套

元素嵌套规范，每个块状元素独立一行，内联元素可选。

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

2.3 CSS

2.3.1 样式文件

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

• 推荐：

@charset “UTF-8”;

.jdc {}

• 不推荐：

/* @charset规则不在文件首行首个字符开始 _/

@charset “UTF-8”;

.jdc {}

/_ @charset规则没有用小写 _/

@CHARSET “UTF-8”;

.jdc {}

/_ 无@charset规则 */

.jdc {}

2.3.2 代码格式化

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

• 推荐：展开格式（Expanded）

.jdc {

display: block;

width: 50px;

}

• 不推荐：紧凑格式 （Compact）

.jdc { display: block; width: 50px;}

2.3.3 代码大小写

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

• 推荐：

.jdc {

display: block;

}

• 不推荐：

.JDC {

DISPLAY: BLOCK;

}

2.3.4 代码易读性

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

• 推荐：

.jdc {

width: 100%;

}

• 不推荐：

.jdc{

width:100%;

}

1. 逗号分隔的取值，逗号之后一个空格。

• 推荐：

.jdc {

box-shadow: 1px 1px 1px #333, 2px 2px 2px #ccc;

}

• 不推荐：

.jdc {

box-shadow: 1px 1px 1px #333,2px 2px 2px #ccc;

}

1. 为单个 CSS 选择器或新声明开启新行。

• 推荐：

.jdc, .jdc_logo, .jdc_hd {

color: #ff0;

}

.nav{

color: #fff;

}

• 不推荐：

.jdc, .jdc_logo, .jdc_hd {

color: #ff0;

}.nav{

color: #fff;

}

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

• 推荐：

.jdc {

color: rgba(255,255,255,.5);

}

• 不推荐：

.jdc {

color: rgba( 255, 255, 255, 0.5 );

}

1. 属性值十六进制数值能用简写的尽量用简写。

• 推荐：

.jdc {

color: #fff;

}

• 不推荐：

.jdc {

color: #ffffff;

}

1. 不要为 0 指明单位。

• 推荐：

.jdc {

margin: 0 10px;

}

• 不推荐：

.jdc {

margin: 0px 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;

}

3.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 中，主要有三种风格，如下：

• 【推荐】One True Brace Style

if (foo) {

bar()

} else {

baz()

}

• Stroustrup

if (foo) {

bar()

}

else {

baz()

}

• Allman

if (foo)

{

bar()

}

else

{

baz()

}

2.4.3 代码中的空格

1. 逗号前后的空格可以提高代码的可读性，团队约定在逗号后面使用空格，逗号前面不加空格。

• 推荐：

var foo = 1, bar = 2

• 不推荐：

var foo = 1,bar = 2

var foo = 1 , bar = 2

var foo = 1 ,bar = 2

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

• 推荐：

var obj = { ‘foo’: ‘haha’ }

• 不推荐：

var obj = { ‘foo’ : ‘haha’ }

1. 代码块前要添加空格。

• 推荐：

if (a) {

b()

}

function a () {}

• 不推荐：

if (a){

b()

}

function a (){}

1. 函数声明括号前要加空格。

• 推荐：

function func (x) {

// …

}

• 不推荐：

function func(x) {

// …

}

1. 在函数调用时，禁止使用空格。

• 推荐：

fn()

• 不推荐：

fn ()

fn

()

1. 在操作符前后都需要添加空格。

• 推荐：

var sum = 1 + 2

• 不推荐：

var sum = 1+2

三、注释规范

---

注释的目的：

• 提高代码的可读性，从而提高代码的可维护性

注释的原则：

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

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

3.1 HTML 文件注释

3.1.1 单行注释

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

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

• 推荐：

…

• 不推荐

…

…

3.1.2 模块注释

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

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

• 推荐：

…

…

• 不推荐

…

…

3.1.3 嵌套模块注释

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

而改用

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

…

…

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 2015-10-10

*/

3.3 JavaScript 文件注释

3.3.1 单行注释

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

• 推荐：

// is current tab

const active = true

• 不推荐：

const active = true // is current tab

注释行的上方需要有一个空行（除非注释行上方是一个块的顶部），以增加可读性。

• 推荐：

function getType () {

console.log(‘fetching type…’)

// set the default type to ‘no 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

}

• 不推荐：

function getType () {

console.log(‘fetching type…’)

// 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
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数前端工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：前端）

最后

正值金三银四招聘旺季，很多小伙伴都询问我有没有前端方面的面试题，特地整理出来赠送给大家！

资料领取方式：点击这里前往获取

--------------- */

.mod_b {}

• 不推荐：

/* Module A ---------------------------------------------------- _/

.mod_a {}

/_ Module B ---------------------------------------------------- */

.mod_b {}

3.2.3 文件注释

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

@charset “UTF-8”;

/**

• @desc File Info

• @author Author Name

• @date 2015-10-10

*/

3.3 JavaScript 文件注释

3.3.1 单行注释

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

• 推荐：

// is current tab

const active = true

• 不推荐：

const active = true // is current tab

注释行的上方需要有一个空行（除非注释行上方是一个块的顶部），以增加可读性。

• 推荐：

function getType () {

console.log(‘fetching type…’)

// set the default type to ‘no 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

}

• 不推荐：

function getType () {

console.log(‘fetching type…’)

// 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
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数前端工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

[外链图片转存中…(img-neoSiNtX-1712766570140)]

[外链图片转存中…(img-DobQ8bQB-1712766570141)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

[外链图片转存中…(img-Di0vRtxm-1712766570141)]

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：前端）

最后

正值金三银四招聘旺季，很多小伙伴都询问我有没有前端方面的面试题，特地整理出来赠送给大家！

资料领取方式：点击这里前往获取