// bad
var getTitle = "LoginTable"

// good
let tableTitle = "LoginTable"
let mySchool = "我的學(xué)校"

1.3.7 常量

命名方法：全部大寫下劃線分割 命名規(guī)范：使用大寫字母和下劃線來組合命名，下劃線用以分割單詞

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

1.3.8 方法

命名方法：camelCase 命名規(guī)范：統(tǒng)一使用動詞或者動詞 + 名詞形式

// 1、普通情況下，使用動詞 + 名詞形式

// bad
go、nextPage、show、open、login

// good
jumpPage、openCarInfoDialog

// 2、請求數(shù)據(jù)方法，以 data 結(jié)尾
// bad
takeData、confirmData、getList、postForm

// good
getListData、postFormData

// 3、單個動詞的情況
init、refresh

1.3.9 自定義事件

自定義事件應(yīng)始終使用 kebab-case 的事件名。

不同于組件和 prop，事件名不存在任何自動化的大小寫轉(zhuǎn)換。而是觸發(fā)的事件名需要完全匹配監(jiān)聽這個事件所用的名稱。

this.$emit('my-event')

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

不同于組件和 prop，事件名不會被用作一個 JavaScript 變量名或 property 名，所以就沒有理由使用 camelCase 或 PascalCase 了。并且v-on 事件監(jiān)聽器在 DOM 模板中會被自動轉(zhuǎn)換為全小寫 (因為 HTML是大小寫不敏感的)，所以 v-on:myEvent 將會變成 v-on:myevent——導(dǎo)致 myEvent不可能被監(jiān)聽到。

由原生事件可以發(fā)現(xiàn)其使用方式如下：

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

而為了區(qū)分_原生事件_和_自定義事件_在 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 命名規(guī)范：handle + 名稱（可選）+ 動詞

<template>
  <div
    @click.native.stop="handleItemClick()"
    @mouseenter.native.stop="handleItemHover()">
  </div>
</template>

<script>

export default {
  methods: {
    handleItemClick () {
      //...
    },
    handleItemHover () {
      //...
    }
  }
}
</script>

??二、代碼規(guī)范

2.1 Vue

2.1.1 代碼結(jié)構(gòu)

<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 必須是一個函數(shù)。

// In a .vue file
export default {
  data () {
    return {
      foo: 'bar'
    }
  }
}

2.1.3 prop

Prop 定義應(yīng)該盡量詳細。

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

2.1.4 computed

應(yīng)該把復(fù)雜計算屬性分割為盡可能多的更簡單的屬性。 小的、專注的計算屬性減少了信息使用時的假設(shè)性限制，所以需求變更時也用不著那么多重構(gòu)了。

// 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 設(shè)置鍵值

在組件上必須用 key 搭配 v-for，以便維護內(nèi)部組件及其子樹的狀態(tài)。

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

為了避免渲染本應(yīng)該被隱藏的列表 (比如 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 的元素應(yīng)該分多行撰寫，每個 attribute 一行。

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

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

<MyComponent
  foo="a"
  bar="b"
  baz="c"/>

2.1.8 模板中簡單的表達式

組件模板應(yīng)該只包含簡單的表達式，復(fù)雜的表達式則應(yīng)該重構(gòu)為計算屬性或方法。

復(fù)雜表達式會讓你的模板變得不那么聲明式。我們應(yīng)該盡量描述應(yīng)該出現(xiàn)的是什么，而非如何計算那個值。而且計算屬性和方法使得代碼可以重用。

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

更好的做法：

<!-- 在模板中 -->
{{ normalizedFullName }}
復(fù)制代碼
// 復(fù)雜表達式已經(jīng)移入一個計算屬性
computed: {
  normalizedFullName: function () {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}

2.1.9 帶引號的 attribute 值

非空 HTML 特性值應(yīng)該始終帶雙引號。

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

??三、注釋規(guī)范

注釋的目的：

• 提高代碼的可讀性，從而提高代碼的可維護性 注釋的原則：
• 如無必要，勿增注釋 ( As short as possible ) ；
• 如有必要，盡量詳盡 ( As long as necessary )。

3.1 HTML 文件注釋

3.1.1 單行注釋

一般用于簡單的描述，如某些狀態(tài)描述、屬性描述等。

注釋內(nèi)容前后各一個空格字符，注釋位于要注釋代碼的上面，單獨占一行。

• 推薦：

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

復(fù)制代碼

• 不推薦

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

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

3.1.2 模塊注釋

一般用于描述模塊的名稱以及模塊開始與結(jié)束的位置。

注釋內(nèi)容前后各一個空格字符， <!-- S Comment Text \-->表示模塊開始， <!-- E Comment Text \-->表示模塊結(jié)束，模塊與模塊之間相隔一行。

• 推薦：

<!-- 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 嵌套模塊注釋

當(dāng)模塊注釋內(nèi)再出現(xiàn)模塊注釋的時候，為了突出主要模塊，嵌套模塊不再使用。

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

而改用

<!-- /Comment Text -->

注釋寫在模塊結(jié)尾標(biāo)簽底部，單獨一行。

<!-- 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 單行注釋

注釋內(nèi)容第一個字符和最后一個字符都是一個空格字符，單獨占一行，行與行之間相隔一行。

• 推薦：

/* Comment Text */ 
.jdc {} 

/* Comment Text */ 
.jdc {}

• 不推薦：

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

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

3.2.2 模塊注釋

注釋內(nèi)容第一個字符和最后一個字符都是一個空格字符，/ 與 模塊信息描述占一行，多個橫線分隔符 - 與 / 占一行，行與行之間相隔兩行。

• 推薦：

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


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

• 不推薦：

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

3.2.3 文件注釋

在樣式文件編碼聲明 @charset 語句下面注明頁面名稱、作者、創(chuàng)建日期等信息。

@charset "UTF-8";
/**
 * @desc File Info
 * @author Author Name
 * @date 2015-10-10
 */

3.3 JavaScript 文件注釋

3.3.1 單行注釋

單行注釋使用 //，注釋應(yīng)單獨一行寫在被注釋對象的上方，不要追加在某條語句的后面。

• 推薦：

// 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 注釋空格

注釋內(nèi)容和注釋符之間需要有一個空格，以增加可讀性。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 特殊標(biāo)記

有時我們發(fā)現(xiàn)某個可能的 bug，但因為一些原因還沒法修復(fù)；或者某個地方還有一些待完成的功能，這時我們需要使用相應(yīng)的特殊標(biāo)記注釋來告知未來的自己或合作者。常用的特殊標(biāo)記有兩種：

• // 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 文檔類注釋

文檔類注釋，如函數(shù)、類、文件、事件等；都使用 jsdoc 規(guī)范。

/**
 * Book類，代表一個書本.
 * @constructor
 * @param {string} title - 書本的標(biāo)題.
 * @param {string} author - 書本的作者.
 */
function Book (title, author) {
  this.title = title
  this.author = author
}

Book.prototype = {
  /**
   * 獲取書本的標(biāo)題
   * @returns {string|*}
   */
  getTitle: function () {
    return this.title
  },
  /**
   * 設(shè)置書本的頁數(shù)
   * @param pageNum {number} 頁數(shù)
   */
  setPageNum: function (pageNum) {
    this.pageNum=pageNum
  }
}

3.3.6 注釋工具

ESLint 是當(dāng)下最流行的 JS 代碼檢查工具，ESLint 中有一些注釋相關(guān)的規(guī)則，用戶可選擇開啟：

• valid-jsdoc

• require-jsdoc

• no-warning-comments

• capitalized-comments

• line-comment-position

• lines-around-comment

• multiline-comment-style

• no-inline-comments

• spaced-comment

??寫在最后

以上就是今天文章的全部內(nèi)容啦！有一個養(yǎng)成編程代碼規(guī)范，對今后開發(fā)以及協(xié)同開發(fā)等都有很大的好處；大家一定要重視起來哦。各位小伙伴讓我們 let’s be prepared at all times！

??JSON包里寫函數(shù)，關(guān)注博主不迷路

?原創(chuàng)不易，還希望各位大佬支持一下！
?? 點贊，你的認可是我創(chuàng)作的動力！
?? 收藏，你的青睞是我努力的方向！
?? 評論，你的意見是我進步的財富！文章來源地址http://www.zghlxwxcb.cn/news/detail-406645.html

到了這里，關(guān)于Vue實戰(zhàn)【Vue開發(fā)中的的前端代碼風(fēng)格規(guī)范】的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！