二、代碼規范
2.1 Vue
.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 props
props 定義應該盡量詳細。
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)。
<ul><liv-for="todo in todos":key="todo.id">{{ todo.text }}</li>
</ul>
2.1.6?v-if
?和?v-for
?互斥
永遠不要把 **v-if**
和 **v-for**
同時用在同一個元素上。
<!-- bad:控制臺報錯 -->
<ul><liv-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><liv-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><liv-for="user in users"v-if="shouldShowUsers":key="user.id">{{ user.name }}</li>
</ul><!-- good -->
<ul v-if="shouldShowUsers"><liv-for="user in users":key="user.id">{{ user.name }}</li>
</ul>
2.1.7 多個 attribute 的元素
多個 attribute 的元素應該分多行撰寫,每個屬性一行。
<!-- bad -->
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
<!-- good -->
<imgsrc="https://vuejs.org/images/logo.png"alt="Vue Logo"><MyComponentfoo="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 代碼易讀性
- 左括號與類名之間一個空格,冒號與屬性值之間一個空格。
- 推薦:
.jdc {width: 100%;
}
- 不推薦:
.jdc{width:100%;
}
- 逗號分隔的取值,逗號之后一個空格。
- 推薦:
.jdc {box-shadow: 1px 1px 1px #333, 2px 2px 2px #ccc;
}
- 不推薦:
.jdc {box-shadow: 1px 1px 1px #333,2px 2px 2px #ccc;
}
- 為單個 CSS 選擇器或新聲明開啟新行。
- 推薦:
.jdc, .jdc_logo, .jdc_hd {color: #ff0;
}.nav{color: #fff;
}
- 不推薦:
.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: rgba( 255, 255, 255, 0.5 );
}
- 屬性值十六進制數值能用簡寫的盡量用簡寫。
- 推薦:
.jdc {color: #fff;
}
- 不推薦:
.jdc {color: #ffffff;
}
- 不要為?
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 代碼中的空格
- 逗號前后的空格可以提高代碼的可讀性,團隊約定在逗號后面使用空格,逗號前面不加空格。
- 推薦:
var foo = 1, bar = 2
- 不推薦:
var foo = 1,bar = 2var foo = 1 , bar = 2var foo = 1 ,bar = 2
- 對象字面量的鍵和值之間不能存在空格,且要求對象字面量的冒號和值之間存在一個空格。
- 推薦:
var obj = { 'foo': 'haha' }
- 不推薦:
var obj = { 'foo' : 'haha' }
- 代碼塊前要添加空格。
- 推薦:
if (a) {b()
}function a () {}
- 不推薦:
if (a){b()
}function a (){}
- 函數聲明括號前要加空格。
- 推薦:
function func (x) {// ...
}
- 不推薦:
function func(x) {// ...
}
- 在函數調用時,禁止使用空格。
- 推薦:
fn()
- 不推薦:
fn ()fn
()
- 在操作符前后都需要添加空格。
- 推薦:
var sum = 1 + 2
- 不推薦:
var sum = 1+2
附件:https://gitee.com/ZhongBangKeJi/CRMEB