关于vue.js:Vue-前端代码风格指南

一、命名标准

市面上罕用的命名标准：

camelCase（小驼峰式命名法 —— 首字母小写）
PascalCase（大驼峰式命名法 —— 首字母大写）
kebab-case（短横线连贯式）
Snake（下划线连贯式）

1.1 我的项目文件命名

1.1.1 我的项目名

全副采纳小写形式，以短横线分隔。例：my-project-name。

1.1.2 目录名

参照我的项目命名规定，有复数构造时，要采纳复数命名法。例：docs、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_sina.gif
menu_aboutus.gif
menutitle_news.gif
logo_police.gif
logo_national.gif
pic_people.jpg
pic_TV.jpg

1.1.4 HTML 文件名

全副采纳小写形式，优先选择单个单词命名，多个单词命名以下划线分隔。

|- error_report.html
|- success_report.html

1.1.5 CSS 文件名

全副采纳小写形式，优先选择单个单词命名，多个单词命名以短横线分隔。

|- normalize.less
|- base.less
|- date-picker.scss
|- input-number.scss

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 前缀命名，以示其唯一性。

这不意味着组件只可用于一个单页面，而是_每个页面_只应用一次。这些组件永远不承受任何 prop，因为它们是为你的利用定制的。如果你发现有必要增加 prop，那就表明这实际上是一个可复用的组件，_只是目前_在每个页面里只应用一次。

比方，头部和侧边栏组件简直在每个页面都会应用，不承受 prop，该组件是专门为该利用所定制的。

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

1.2.3 根底组件名

根底组件：不蕴含业务，独立、具体性能的根底组件，比方日期选择器、模态框等。这类组件作为我的项目的根底控件，会被大量应用，因而组件的 API 进行过高强度的形象，能够通过不同配置实现不同的性能。

利用特定款式和约定的根底组件 (也就是展现类的、无逻辑的或无状态、不掺杂业务逻辑的组件) 应该全副以一个特定的前缀结尾 —— Base。 根底组件在一个页面内可应用屡次，在不同页面内也可复用，是高可复用组件。

components/
|- BaseButton.vue
|- 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
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue

还有另一种多级目录的形式，把所有的搜寻组件放到“search”目录，把所有的设置组件放到“settings”目录。咱们只举荐在十分大型 (如有 100+ 个组件) 的利用下才思考这么做，因为在多级目录间找来找去，要比在单个 components 目录下滚动查找要花费更多的精力。

1.2.7 残缺单词的组件名

组件名应该偏向于而不是缩写。编辑器中的主动补全曾经让书写长命名的代价十分之低了，而其带来的明确性却是十分贵重的。不罕用的缩写尤其应该防止。

components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue

1.3 代码参数命名

1.3.1 name

组件名应该始终是多个单词，应该始终是 PascalCase 的。根组件 App 以及 <transition>、<component> 之类的 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/>

<!-- 在 DOM 模板中 --> 
<my-component></my-component>

1.3.5 自闭合组件

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

<!-- 在单文件组件和字符串模板中 -->
<MyComponent/>

<!-- 在所有中央 -->
<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、单个动词的状况
init、refresh

1.3.9 自定义事件

自定义事件应始终应用 kebab-case 的事件名。

不同于组件和 prop，事件名不存在任何自动化的大小写转换。而是触发的事件名须要齐全匹配监听这个事件所用的名称。

this.$emit('my-event')

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

不同于组件和 prop，事件名不会被用作一个 JavaScript 变量名或 property 名，所以就没有理由应用 camelCase 或 PascalCase 了。并且 v-on 事件监听器在 DOM 模板中会被主动转换为全小写 (因为 HTML 是大小写不敏感的)，所以 v-on:myEvent 将会变成 v-on:myevent——导致 myEvent 不可能被监听到。

原生事件参考列表

由原生事件能够发现其应用形式如下：

<div
  @blur="toggleHeaderFocus"
  @focus="toggleHeaderFocus"
  @click="toggleMenu"
  @keydown.esc="handleKeydown"
  @keydown.enter="handleKeydown"
  @keydown.up.prevent="handleKeydown"
  @keydown.down.prevent="handleKeydown"
  @keydown.tab="handleKeydown"
  @keydown.delete="handleKeydown"
  @mouseenter="hasMouseHoverHead = true"
  @mouseleave="hasMouseHoverHead = false">
</div>

而为了辨别_原生事件_和_自定义事件_在 Vue 中的应用，倡议除了多单词事件名应用 kebab-case 的状况下，命名还需恪守为 on + 动词 的模式，如下：

<!-- 父组件 -->
<div
  @on-search="handleSearch"
  @on-clear="handleClear"
  @on-clickoutside="handleClickOutside">
</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 必须是一个函数。

// 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，以便保护外部组件及其子树的状态。

<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 同时用在同一个元素上。

<!-- bad：控制台报错 -->
<ul>
  <li
    v-for="user in users"
    v-if="shouldShowUsers"
    :key="user.id">
      {{user.name}}
  </li>
</ul>

个别咱们在两种常见的状况下会偏向于这样做：

为了过滤一个列表中的我的项目 (比方 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 文件模板

HTML5 文件模板：

<!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 代码嵌套

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

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

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

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

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

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

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%;}

2、逗号分隔的取值，逗号之后一个空格。

举荐：

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

不举荐：

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

3、为单个 CSS 选择器或新申明开启新行。

举荐：

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

.nav{color: #fff;}

不举荐：

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

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

举荐：

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

不举荐：

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

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

举荐：

.jdc {color: #fff;}

不举荐：

.jdc {color: #ffffff;}

6、不要为 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 属性书写倡议

倡议遵循以下程序：

布局定位属性：display / position / float / clear / visibility / overflow

本身属性：width / height / margin / padding / border / background

文本属性：color / font / text-decoration / text-align / vertical-align / white- space / break-word

其余属性（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

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

举荐：

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

不举荐：

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

3、代码块前要增加空格。

举荐：

if (a) {b()
}

function a () {}

不举荐：

if (a){b()
}

function a (){}

4、函数申明括号前要加空格。

举荐：

function func (x) {// ...}

不举荐：

function func(x) {// ...}

5、在函数调用时，禁止应用空格。

举荐：

fn()

不举荐：

fn ()

fn
()

6、在操作符前后都须要增加空格。

举荐：

var sum = 1 + 2

不举荐：

var sum = 1+2

三、正文标准

正文的目标：

进步代码的可读性，从而进步代码的可维护性
正文的准则：

如无必要，勿增正文 (As short as possible)

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

3.1 HTML 文件正文

3.1.1 单行正文

个别用于简略的形容，如某些状态形容、属性形容等。

正文内容前后各一个空格字符，正文位于要正文代码的下面，独自占一行。

举荐：

<!-- Comment Text -->
<div>...</div>

不举荐：

<div>...</div><!-- Comment Text -->

<div><!-- Comment Text -->
  ...
</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>
    <!-- /mod_b -->
     
    <div class="mod_c">
     ...
    </div>
    <!-- /mod_c -->
  
</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 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
}

不举荐：

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

  return element
}

3.3.3 正文空格

正文内容和正文符之间须要有一个空格，以减少可读性。eslint: spaced-comment。

举荐：

// is current tab
const active = true

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

  return element
}

不举荐：

//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 中有一些正文相干的规定，用户可抉择开启：

valid-jsdoc

require-jsdoc

no-warning-comments

capitalized-comments

line-comment-position

lines-around-comment

multiline-comment-style

no-inline-comments

spaced-comment