Vue 前端程式碼風格指南

墨城發表於2021-12-17
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
動詞含義返回值
can判斷是否可執行某個動作 (權 )函式返回一個布林值。true：可執行；false：不可執行；
has判斷是否含有某個值函式返回一個布林值。true：含有此值；false：不含有此值；
is判斷是否為某個值函式返回一個布林值。true：為某個值；false：不為某個值；
get獲取某個值函式返回一個非布林值
set設定某個值無返回值、返回是否設定成功或者返回鏈式物件

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

相關文章