這篇文章主要介紹“vue項(xiàng)目名可不可以用中文”,在日常操作中,相信很多人在vue項(xiàng)目名可不可以用中文問(wèn)題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”vue項(xiàng)目名可不可以用中文”的疑惑有所幫助!接下來(lái),請(qǐng)跟著小編一起來(lái)學(xué)習(xí)吧!
成都創(chuàng)新互聯(lián)專(zhuān)注于蒙山網(wǎng)站建設(shè)服務(wù)及定制,我們擁有豐富的企業(yè)做網(wǎng)站經(jīng)驗(yàn)。 熱誠(chéng)為您提供蒙山營(yíng)銷(xiāo)型網(wǎng)站建設(shè),蒙山網(wǎng)站制作、蒙山網(wǎng)頁(yè)設(shè)計(jì)、蒙山網(wǎng)站官網(wǎng)定制、小程序設(shè)計(jì)服務(wù),打造蒙山網(wǎng)絡(luò)公司原創(chuàng)品牌,更為您提供蒙山網(wǎng)站排名全網(wǎng)營(yíng)銷(xiāo)落地服務(wù)。
vue項(xiàng)目名不可以用中文。在vue中,項(xiàng)目名不能帶中文、大寫(xiě)字母、特殊符號(hào),項(xiàng)目名可采用小寫(xiě)方式,以短橫線分隔,例“my-project-name”。而在單文件組件和字符串模板中組件名應(yīng)該總是PascalCase的,但是在DOM模板中總是kebab-case的。
市面上常用的命名規(guī)范:
camelCase (小駝峰式命名法–首字母小寫(xiě))
PascalCase (大駝峰式命名法–首字母大寫(xiě))
kebab-case(短橫線連接式)
Snake(下劃線連接式)
規(guī)則可以快速記憶為“靜態(tài)文件下劃線,編譯文件短橫線”。
項(xiàng)目名不能帶中文、大寫(xiě)字母、特殊符號(hào)。
英文全部采用小寫(xiě)方式,以短橫線分隔。例:my-project-name
參照項(xiàng)目命名規(guī)則,有復(fù)數(shù)結(jié)構(gòu)時(shí),要采用復(fù)數(shù)命名法。例:docs、assets、components、directives、mixins、utils、views
my-project-name/
|- BuildScript // 流水線部署文件目錄
|- docs // 項(xiàng)目的細(xì)化文檔目錄(可選)
|- nginx // 部署在容器上前端項(xiàng)目 nginx 代理文件目錄
|- node_modules // 下載的依賴包
|- public // 靜態(tài)頁(yè)面目錄
|- index.html // 項(xiàng)目入口
|- src // 源碼目錄
|- api // http 請(qǐng)求目錄
|- assets // 靜態(tài)資源目錄,這里的資源會(huì)被wabpack構(gòu)建
|- icon // icon 存放目錄
|- img // 圖片存放目錄
|- js // 公共 js 文件目錄
|- scss // 公共樣式 scss 存放目錄
|- frame.scss // 入口文件
|- global.scss // 公共樣式
|- reset.scss // 重置樣式
|- components // 組件
|- plugins // 插件
|- router // 路由
|- routes // 詳細(xì)的路由拆分目錄(可選)
|- index.js
|- store // 全局狀態(tài)管理
|- utils // 工具存放目錄
|- request.js // 公共請(qǐng)求工具
|- views // 頁(yè)面存放目錄
|- App.vue // 根組件
|- main.js // 入口文件
|- tests // 測(cè)試用例
|- .browserslistrc// 瀏覽器兼容配置文件
|- .editorconfig // 編輯器配置文件
|- .eslintignore // eslint 忽略規(guī)則
|- .eslintrc.js // eslint 規(guī)則
|- .gitignore // git 忽略規(guī)則
|- babel.config.js // babel 規(guī)則
|- Dockerfile // Docker 部署文件
|- jest.config.js
|- package-lock.json
|- package.json // 依賴
|- README.md // 項(xiàng)目 README
|- vue.config.js // webpack 配置
全部采用小寫(xiě)方式, 優(yōu)先選擇單個(gè)單詞命名,多個(gè)單詞命名以下劃線分隔。
banner_sina.gif
menu_aboutus.gif
menutitle_news.gif
logo_police.gif
logo_national.gif
pic_people.jpg
pic_TV.jpg
全部采用小寫(xiě)方式, 優(yōu)先選擇單個(gè)單詞命名,多個(gè)單詞命名以下劃線分隔。
|- error_report.html
|- success_report.html
全部采用小寫(xiě)方式, 優(yōu)先選擇單個(gè)單詞命名,多個(gè)單詞命名以短橫線分隔。
|- normalize.less
|- base.less
|- date-picker.scss
|- input-number.scss
全部采用小寫(xiě)方式, 優(yōu)先選擇單個(gè)單詞命名,多個(gè)單詞命名以短橫線分隔。
|- index.js
|- plugin.js
|- util.js
|- date-util.js
|- account-model.js
|- collapse-transition.js
上述規(guī)則可以快速記憶為“靜態(tài)文件下劃線,編譯文件短橫線”。
文件擴(kuò)展名為.vue的single-file components(單文件組件)。單文件組件名應(yīng)該始終是單詞大寫(xiě)開(kāi)頭(PascalCase)。
components/
|- MyComponent.vue
只擁有單個(gè)活躍實(shí)例的組件應(yīng)該以 The 前綴命名,以示其唯一性。
這不意味著組件只可用于一個(gè)單頁(yè)面,而是_每個(gè)頁(yè)面_只使用一次。這些組件永遠(yuǎn)不接受任何 prop,因?yàn)樗鼈兪菫槟愕膽?yīng)用定制的。如果你發(fā)現(xiàn)有必要添加 prop,那就表明這實(shí)際上是一個(gè)可復(fù)用的組件,_只是目前_在每個(gè)頁(yè)面里只使用一次。
比如,頭部和側(cè)邊欄組件幾乎在每個(gè)頁(yè)面都會(huì)使用,不接受 prop,該組件是專(zhuān)門(mén)為該應(yīng)用所定制的。
components/
|- TheHeading.vue
|- TheSidebar.vue
基礎(chǔ)組件:不包含業(yè)務(wù),獨(dú)立、具體功能的基礎(chǔ)組件,比如日期選擇器、模態(tài)框等。這類(lèi)組件作為項(xiàng)目的基礎(chǔ)控件,會(huì)被大量使用,因此組件的 API 進(jìn)行過(guò)高強(qiáng)度的抽象,可以通過(guò)不同配置實(shí)現(xiàn)不同的功能。
應(yīng)用特定樣式和約定的基礎(chǔ)組件(也就是展示類(lèi)的、無(wú)邏輯的或無(wú)狀態(tài)、不摻雜業(yè)務(wù)邏輯的組件) 應(yīng)該全部以一個(gè)特定的前綴開(kāi)頭 —— Base。
基礎(chǔ)組件在一個(gè)頁(yè)面內(nèi)可使用多次,在不同頁(yè)面內(nèi)也可復(fù)用,是高可復(fù)用組件。
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
業(yè)務(wù)組件:它不像基礎(chǔ)組件只包含某個(gè)功能,而是在業(yè)務(wù)中被多個(gè)頁(yè)面復(fù)用的(具有可復(fù)用性),它與基礎(chǔ)組件的區(qū)別是,業(yè)務(wù)組件只在當(dāng)前項(xiàng)目中會(huì)用到,不具有通用性,而且會(huì)包含一些業(yè)務(wù),比如數(shù)據(jù)請(qǐng)求;而基礎(chǔ)組件不含業(yè)務(wù),在任何項(xiàng)目中都可以使用,功能單一,比如一個(gè)具有數(shù)據(jù)校驗(yàn)功能的輸入框。
摻雜了復(fù)雜業(yè)務(wù)的組件(擁有自身 data、prop 的相關(guān)處理)即業(yè)務(wù)組件應(yīng)該以 Custom 前綴命名。
業(yè)務(wù)組件在一個(gè)頁(yè)面內(nèi)比如:某個(gè)頁(yè)面內(nèi)有一個(gè)卡片列表,而樣式和邏輯跟業(yè)務(wù)緊密相關(guān)的卡片就是業(yè)務(wù)組件。
components/
|- CustomCard.vue
和父組件緊密耦合的子組件應(yīng)該以父組件名作為前綴命名。
因?yàn)榫庉嬈魍ǔ?huì)按字母順序組織文件,所以這樣做可以把相關(guān)聯(lián)的文件排在一起。
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
組件名應(yīng)該以高級(jí)別的 (通常是一般化描述的) 單詞開(kāi)頭,以描述性的修飾詞結(jié)尾。
因?yàn)榫庉嬈魍ǔ?huì)按字母順序組織文件,所以現(xiàn)在組件之間的重要關(guān)系一目了然。如下組件主要是用于搜索和設(shè)置功能。
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue
還有另一種多級(jí)目錄的方式,把所有的搜索組件放到“search”目錄,把所有的設(shè)置組件放到“settings”目錄。我們只推薦在非常大型 (如有 100+ 個(gè)組件) 的應(yīng)用下才考慮這么做,因?yàn)樵诙嗉?jí)目錄間找來(lái)找去,要比在單個(gè) components 目錄下滾動(dòng)查找要花費(fèi)更多的精力。
組件名應(yīng)該傾向于完整得單詞而不是縮寫(xiě)。
編輯器中的自動(dòng)補(bǔ)全已經(jīng)讓書(shū)寫(xiě)長(zhǎng)命名的代價(jià)非常之低了,而其帶來(lái)的明確性卻是非常寶貴的。不常用的縮寫(xiě)尤其應(yīng)該避免。
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
組件名應(yīng)該始終是多個(gè)單詞,應(yīng)該始終是 PascalCase 的。根組件 App 以及 、 之類(lèi)的 Vue 內(nèi)置組件除外。這樣做可以避免跟現(xiàn)有的以及未來(lái)的 HTML 元素相沖突,因?yàn)樗械?HTML 元素名稱都是單個(gè)單詞的。
export default {
name: 'ToDoList',
// ...}
在聲明 prop 的時(shí)候,其命名應(yīng)該始終使用 camelCase,而在模板和 JSX 中應(yīng)該始終使用 kebab-case。
我們單純的遵循每個(gè)語(yǔ)言的約定,在 JavaScript 中更自然的是 camelCase。而在 HTML 中則是 kebab-case。
export default {
name: 'MyComponent',
// ...
props: {
greetingText: {
type: String,
required: true,
validator: function (value) {
return ['syncing', 'synced',].indexOf(value) !== -1
}
}
}}
Vue Router Path 命名采用 kebab-case 格式。用 Snake(如:/user_info)或 camelCase(如:/userInfo)的單詞會(huì)被當(dāng)成一個(gè)單詞,搜索引擎無(wú)法區(qū)分語(yǔ)義。
// bad{
path: '/user_info', // user_info 當(dāng)成一個(gè)單詞
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用戶',
desc: ''
}},// good{
path: '/user-info', // 能解析成 user info
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用戶',
desc: ''
}},
對(duì)于絕大多數(shù)項(xiàng)目來(lái)說(shuō),在單文件組件和字符串模板中組件名應(yīng)該總是 PascalCase 的,但是在 DOM 模板中總是 kebab-case 的。
在單文件組件、字符串模板和 JSX 中沒(méi)有內(nèi)容的組件應(yīng)該是自閉合的——但在 DOM 模板里永遠(yuǎn)不要這樣做。
命名方法:camelCase
命名規(guī)范:類(lèi)型 + 對(duì)象描述或?qū)傩缘姆绞?/p>
// bad
var getTitle = "LoginTable"
// good
let tableTitle = "LoginTable"
let mySchool = "我的學(xué)校"
命名方法:全部大寫(xiě)下劃線分割
命名規(guī)范:使用大寫(xiě)字母和下劃線來(lái)組合命名,下劃線用以分割單詞
const MAX_COUNT = 10
const URL = 'http://test.host.com'
命名方法:camelCase
命名規(guī)范:統(tǒng)一使用動(dòng)詞或者動(dòng)詞 + 名詞形式
// 1、普通情況下,使用動(dòng)詞 + 名詞形式
// bad
go、nextPage、show、open、login
// good
jumpPage、openCarInfoDialog
// 2、請(qǐng)求數(shù)據(jù)方法,以 data 結(jié)尾
// bad
takeData、confirmData、getList、postForm
// good
getListData、postFormData
// 3、單個(gè)動(dòng)詞的情況
init、refresh
動(dòng)詞 | 含義 | 返回值 |
---|---|---|
can | 判斷是否可執(zhí)行某個(gè)動(dòng)作 (權(quán) ) | 函數(shù)返回一個(gè)布爾值。true:可執(zhí)行;false:不可執(zhí)行 |
has | 判斷是否含有某個(gè)值 | 函數(shù)返回一個(gè)布爾值。true:含有此值;false:不含有此值; |
is | 判斷是否為某個(gè)值 | 函數(shù)返回一個(gè)布爾值。true:為某個(gè)值;false:不為某個(gè)值; |
get | 獲取某個(gè)值 | 函數(shù)返回一個(gè)非布爾值 |
set | 設(shè)置某個(gè)值 | 無(wú)返回值、返回是否設(shè)置成功或者返回鏈?zhǔn)綄?duì)象 |
自定義事件應(yīng)始終使用 kebab-case 的事件名。
不同于組件和 prop,事件名不存在任何自動(dòng)化的大小寫(xiě)轉(zhuǎn)換。而是觸發(fā)的事件名需要完全匹配監(jiān)聽(tīng)這個(gè)事件所用的名稱。
this.$emit('my-event')
不同于組件和 prop,事件名不會(huì)被用作一個(gè) JavaScript 變量名或 property 名,所以就沒(méi)有理由使用 camelCase 或 PascalCase 了。并且 v-on 事件監(jiān)聽(tīng)器在 DOM 模板中會(huì)被自動(dòng)轉(zhuǎn)換為全小寫(xiě) (因?yàn)?HTML 是大小寫(xiě)不敏感的),所以 v-on:myEvent 將會(huì)變成 v-on:myevent——導(dǎo)致 myEvent 不可能被監(jiān)聽(tīng)到。
原生事件參考列表[1]
由原生事件可以發(fā)現(xiàn)其使用方式如下:
而為了區(qū)分_原生事件_和_自定義事件_在 Vue 中的使用,建議除了多單詞事件名使用 kebab-case 的情況下,命名還需遵守為 on + 動(dòng)詞 的形式,如下:
// 子組件
export default {
methods: {
handleTriggerItem () {
this.$emit('on-clear')
}
}
}
命名方法:camelCase
命名規(guī)范:handle + 名稱(可選)+ 動(dòng)詞
組件的 data 必須是一個(gè)函數(shù)。
// In a .vue file
export default {
data () {
return {
foo: 'bar'
}
}
}
Prop 定義應(yīng)該盡量詳細(xì)。
export default {
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
}
應(yīng)該把復(fù)雜計(jì)算屬性分割為盡可能多的更簡(jiǎn)單的屬性。
小的、專(zhuān)注的計(jì)算屬性減少了信息使用時(shí)的假設(shè)性限制,所以需求變更時(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
}
}
在組件上必須用 key 搭配 v-for,以便維護(hù)內(nèi)部組件及其子樹(shù)的狀態(tài)。甚至在元素上維護(hù)可預(yù)測(cè)的行為,比如動(dòng)畫(huà)中的對(duì)象固化 (object constancy)[2]。
永遠(yuǎn)不要把 v-if 和 v-for 同時(shí)用在同一個(gè)元素上。
一般我們?cè)趦煞N常見(jiàn)的情況下會(huì)傾向于這樣做:
為了過(guò)濾一個(gè)列表中的項(xiàng)目 (比如 v-for=“user in users” v-if=“user.isActive”)。在這種情形下,請(qǐng)將 users 替換為一個(gè)計(jì)算屬性 (比如 activeUsers),讓其返回過(guò)濾后的列表。
computed: {
activeUsers: function () {
return this.users.filter((user) => {
return user.isActive
})
}
}
為了避免渲染本應(yīng)該被隱藏的列表 (比如 v-for=“user in users” v-if=“shouldShowUsers”)。這種情形下,請(qǐng)將 v-if 移動(dòng)至容器元素上 (比如 ul, ol)。
多個(gè) attribute 的元素應(yīng)該分多行撰寫(xiě),每個(gè) attribute 一行。
組件模板應(yīng)該只包含簡(jiǎn)單的表達(dá)式,復(fù)雜的表達(dá)式則應(yīng)該重構(gòu)為計(jì)算屬性或方法
復(fù)雜表達(dá)式會(huì)讓你的模板變得不那么聲明式。我們應(yīng)該盡量描述應(yīng)該出現(xiàn)的是什么,而非如何計(jì)算那個(gè)值。而且計(jì)算屬性和方法使得代碼可以重用。
// bad
{{
fullName.split(' ').map((word) => {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}
更好的做法:
{{ normalizedFullName }}
// 復(fù)雜表達(dá)式已經(jīng)移入一個(gè)計(jì)算屬性
computed: {
normalizedFullName: function () {
return this.fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}
}
非空 HTML 特性值應(yīng)該始終帶雙引號(hào)。
用 : 表示 v-bind:
用 @ 表示 v-on:
用 # 表示 v-slot:
Here's some contact info
Here might be a page title
HTML5 文件模板:
移動(dòng)端:
PC 端:
HTML 元素共有以下5種:
空元素:area、base、br、col、command、embed、hr、img、input、keygen、link、meta、param、source、track、wbr
原始文本元素:script、style
RCDATA 元素:textarea、title
外來(lái)元素:來(lái)自 MathML 命名空間和 SVG 命名空間的元素
常規(guī)元素:其他 HTML 允許的元素都稱為常規(guī)元素
為了能讓瀏覽器更好的解析代碼以及能讓代碼具有更好的可讀性,有如下約定:
所有具有開(kāi)始標(biāo)簽和結(jié)束標(biāo)簽的元素都要寫(xiě)上起止標(biāo)簽,某些允許省略開(kāi)始標(biāo)簽或和束標(biāo)簽的元素亦都要寫(xiě)上。
空元素標(biāo)簽都不加 “/” 字符。
我是一段文字,我有始有終,瀏覽器能正確解析 我是一段文字,我有始無(wú)終,瀏覽器亦能正確解析
我是h2標(biāo)題
我是h2標(biāo)題
元素嵌套規(guī)范,每個(gè)塊狀元素獨(dú)立一行,內(nèi)聯(lián)元素可選。
段落元素與標(biāo)題元素只能嵌套內(nèi)聯(lián)元素。
推薦:
@charset "UTF-8";
.jdc {}
不推薦:
/* @charset規(guī)則不在文件首行首個(gè)字符開(kāi)始 */
@charset "UTF-8";
.jdc {}
/* @charset規(guī)則沒(méi)有用小寫(xiě) */
@CHARSET "UTF-8";
.jdc {}
/* 無(wú)@charset規(guī)則 */
.jdc {}
樣式書(shū)寫(xiě)一般有兩種:一種是緊湊格式 (Compact),一種是展開(kāi)格式(Expanded)。
推薦:展開(kāi)格式(Expanded)
.jdc {
display: block;
width: 50px;
}
不推薦:緊湊格式 (Compact)
.jdc { display: block; width: 50px;}
樣式選擇器,屬性名,屬性值關(guān)鍵字全部使用小寫(xiě)字母書(shū)寫(xiě),屬性字符串允許使用大小寫(xiě)。
推薦:
.jdc {
display: block;
}
不推薦:
.JDC {
DISPLAY: BLOCK;
}
左括號(hào)與類(lèi)名之間一個(gè)空格,冒號(hào)與屬性值之間一個(gè)空格。
推薦:
.jdc {
width: 100%;
}
不推薦:
.jdc{
width:100%;
}
逗號(hào)分隔的取值,逗號(hào)之后一個(gè)空格。
推薦:
.jdc {
box-shadow: 1px 1px 1px #333, 2px 2px 2px #ccc;
}
不推薦:
.jdc {
box-shadow: 1px 1px 1px #333,2px 2px 2px #ccc;
}
為單個(gè) CSS 選擇器或新聲明開(kāi)啟新行。
推薦:
.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 );
}
屬性值十六進(jìn)制數(shù)值能用簡(jiǎn)寫(xiě)的盡量用簡(jiǎn)寫(xiě)。
推薦:
.jdc {
color: #fff;
}
不推薦:
.jdc {
color: #ffffff;
}
不要為 0 指明單位。
推薦:
.jdc {
margin: 0 10px;
}
不推薦:
.jdc {
margin: 0px 10px;
}
CSS 屬性值需要用到引號(hào)時(shí),統(tǒng)一使用單引號(hào)。
推薦:
.jdc {
font-family: 'Hiragino Sans GB';
}
不推薦:
.jdc {
font-family: "Hiragino Sans GB";
}
建議遵循以下順序:
局定位屬性: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;
}
CSS3 瀏覽器私有前綴在前,標(biāo)準(zhǔn)前綴在后。
.jdc {
-webkit-border-radius: 10px;
-moz-border-radius: 10px;
-o-border-radius: 10px;
-ms-border-radius: 10px;
border-radius: 10px;
}
在單行代碼塊中使用空格。
不推薦:
function foo () {return true}
if (foo) {bar = 0}
推薦:
function foo () { return true }
if (foo) { bar = 0 }
在編程過(guò)程中,大括號(hào)風(fēng)格與縮進(jìn)風(fēng)格緊密聯(lián)系,用來(lái)描述大括號(hào)相對(duì)代碼塊位置的方法有很多。在 JavaScript 中,主要有三種風(fēng)格,如下:
【推薦】One True Brace Style
if (foo) {
bar()
} else {
baz()
}
Stroustrup
if (foo) {
bar()
}
else {
baz()
}
Allman
if (foo)
{
bar()
}
else
{
baz()
}
逗號(hào)前后的空格可以提高代碼的可讀性,團(tuán)隊(duì)約定在逗號(hào)后面使用空格,逗號(hào)前面不加空格。
推薦:
var foo = 1, bar = 2
不推薦:
var foo = 1,bar = 2
var foo = 1 , bar = 2
var foo = 1 ,bar = 2
對(duì)象字面量的鍵和值之間不能存在空格,且要求對(duì)象字面量的冒號(hào)和值之間存在一個(gè)空格。
推薦:
var obj = { 'foo': 'haha' }
不推薦:
var obj = { 'foo' : 'haha' }
代碼塊前要添加空格。
推薦:
if (a) {
b()
}
function a () {}
不推薦:
if (a){
b()
}
function a (){}
函數(shù)聲明括號(hào)前要加空格。
推薦:
function func (x) {
// ...
}
不推薦:
function func(x) {
// ...
}
在函數(shù)調(diào)用時(shí),禁止使用空格。
推薦:
fn()
不推薦:
fn ()
fn
()
在操作符前后都需要添加空格
推薦:
var sum = 1 + 2
不推薦:
var sum = 1+2
注釋的目的:
提高代碼的可讀性,從而提高代碼的可維護(hù)性
注釋的原則:
如無(wú)必要,勿增注釋 ( As short as possible )
如有必要,盡量詳盡 ( As long as necessary )
一般用于簡(jiǎn)單的描述,如某些狀態(tài)描述、屬性描述等。
注釋內(nèi)容前后各一個(gè)空格字符,注釋位于要注釋代碼的上面,單獨(dú)占一行。
推薦:
不推薦:
一般用于描述模塊的名稱以及模塊開(kāi)始與結(jié)束的位置。
注釋內(nèi)容前后各一個(gè)空格字符, 表示模塊開(kāi)始, 表示模塊結(jié)束,模塊與模塊之間相隔一行。
推薦:
不推薦:
當(dāng)模塊注釋內(nèi)再出現(xiàn)模塊注釋的時(shí)候,為了突出主要模塊,嵌套模塊不再使用。
而改用
注釋寫(xiě)在模塊結(jié)尾標(biāo)簽底部,單獨(dú)一行。
注釋內(nèi)容第一個(gè)字符和最后一個(gè)字符都是一個(gè)空格字符,單獨(dú)占一行,行與行之間相隔一行。
推薦:
/* Comment Text */
.jdc {}
/* Comment Text */
.jdc {}
不推薦:
/*Comment Text*/
.jdc {
display: block;
}
.jdc {
display: block;/*Comment Text*/
}
注釋內(nèi)容第一個(gè)字符和最后一個(gè)字符都是一個(gè)空格字符,/* 與 模塊信息描述占一行,多個(gè)橫線分隔符 - 與 */ 占一行,行與行之間相隔兩行。
推薦:
/* Module A
---------------------------------------------------------------- */
.mod_a {}
/* Module B
---------------------------------------------------------------- */
.mod_b {}
不推薦:
/* Module A ---------------------------------------------------- */
.mod_a {}
/* Module B ---------------------------------------------------- */
.mod_b {}
在樣式文件編碼聲明 @charset 語(yǔ)句下面注明頁(yè)面名稱、作者、創(chuàng)建日期等信息。
@charset "UTF-8";
/**
* @desc File Info
* @author Author Name
* @date 2015-10-10
*/
單行注釋使用 //,注釋?xiě)?yīng)單獨(dú)一行寫(xiě)在被注釋對(duì)象的上方,不要追加在某條語(yǔ)句的后面。
推薦:
// is current tab
const active = true
不推薦:
const active = true // is current tab
注釋行的上方需要有一個(gè)空行(除非注釋行上方是一個(gè)塊的頂部),以增加可讀性。
推薦:
function getType () {
console.log('fetching type...')
// set the default type to 'no type'
const type = this.type || 'no type'
return type
}
// 注釋行上面是一個(gè)塊的頂部時(shí)不需要空行
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
}
多行注釋使用 /** … */,而不是多行的 //。
推薦:
/**
* 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
}
注釋內(nèi)容和注釋符之間需要有一個(gè)空格,以增加可讀性。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
}
有時(shí)我們發(fā)現(xiàn)某個(gè)可能的 bug,但因?yàn)橐恍┰蜻€沒(méi)法修復(fù);或者某個(gè)地方還有一些待完成的功能,這時(shí)我們需要使用相應(yīng)的特殊標(biāo)記注釋來(lái)告知未來(lái)的自己或合作者。常用的特殊標(biāo)記有兩種:
// FIXME : 說(shuō)明問(wèn)題是什么
// TODO : 說(shuō)明還要做什么或者問(wèn)題的解決方案
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
}
}
文檔類(lèi)注釋?zhuān)绾瘮?shù)、類(lèi)、文件、事件等;都使用 jsdoc 規(guī)范。
/**
* Book類(lèi),代表一個(gè)書(shū)本.
* @constructor
* @param {string} title - 書(shū)本的標(biāo)題.
* @param {string} author - 書(shū)本的作者.
*/
function Book (title, author) {
this.title = title
this.author = author
}
Book.prototype = {
/**
* 獲取書(shū)本的標(biāo)題
* @returns {string|*}
*/
getTitle: function () {
return this.title
},
/**
* 設(shè)置書(shū)本的頁(yè)數(shù)
* @param pageNum {number} 頁(yè)數(shù)
*/
setPageNum: function (pageNum) {
this.pageNum=pageNum
}
}
ESLint是當(dāng)下最流行的 JS 代碼檢查工具,ESLint 中有一些注釋相關(guān)的規(guī)則,用戶可選擇開(kāi)啟:
valid-jsdoc
require-jsdoc
no-warning-comments
capitalized-comments
line-comment-position
lines-around-comment
multiline-comment-style
no-inline-comments
spaced-comment
縮進(jìn)換行請(qǐng)使用兩個(gè)空格。
大型團(tuán)隊(duì)多人協(xié)作項(xiàng)目推薦 JavaScript 代碼末尾加分號(hào)。
小型個(gè)人創(chuàng)新練手項(xiàng)目可嘗試使用 JavaScript 代碼末尾不加分號(hào)的風(fēng)格,更加清爽簡(jiǎn)練。
到此,關(guān)于“vue項(xiàng)目名可不可以用中文”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)?lái)更多實(shí)用的文章!