成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專(zhuān)欄INFORMATION COLUMN

變量命名規(guī)范

MycLambert / 848人閱讀

摘要:函數(shù)的命名規(guī)范拼寫(xiě)準(zhǔn)確比如我的與把函數(shù)未執(zhí)行歸咎于代碼邏輯問(wèn)題使用正常的時(shí)態(tài)特別是代碼中狀態(tài)的變量或者函數(shù)的命名,比如表示已經(jīng)啟動(dòng)了,表示正在連接。

變量命名規(guī)范 前言

好的命名規(guī)范可以讓你不用天天為取名字而苦惱、找bug時(shí),更快的定位到bug在哪個(gè)位置

組件的命名和它的功能相配套

不與其他業(yè)務(wù)組件重名,讓人一眼就區(qū)分

不一定要好聽(tīng)酷炫,但是實(shí)用.讓開(kāi)發(fā)者產(chǎn)生條件反射,看到命名就會(huì)想到這個(gè)組件的實(shí)用場(chǎng)景

易寫(xiě)易記,短小卻精煉,不繁瑣

BEM

.nav某一塊展示/功能區(qū)域 (div)
.nav__item這塊展示/功能區(qū)域(div)里面的某個(gè)元素,比如: nav__item
.nav__item--hide/ .nav__item--open 某個(gè)元素或者某個(gè)塊的狀態(tài)

不要加敏感詞匯

我曾經(jīng)給一個(gè)元素取了個(gè)class為advertisement,后來(lái)測(cè)試人員發(fā)現(xiàn)頁(yè)面上這塊元素不見(jiàn)了。后來(lái)發(fā)現(xiàn)360瀏覽器開(kāi)啟去廣告模式,直接把這個(gè)div給刪了。

函數(shù)的命名規(guī)范

拼寫(xiě)準(zhǔn)確 比如我的confirm與confrim 把函數(shù)未執(zhí)行歸咎于代碼邏輯問(wèn)題

使用正常的時(shí)態(tài)

特別是代碼中狀態(tài)的變量或者函數(shù)的命名,比如 onXxxxStarted 表示xxx已經(jīng)啟動(dòng)了,isConnecting表示正在連接。正確的時(shí)態(tài)可以給使用者傳遞準(zhǔn)確的信息。

函數(shù)和屬性的命名是有區(qū)別的

如果是函數(shù),建議使用動(dòng)賓結(jié)構(gòu)

動(dòng)賓結(jié)構(gòu)就是 doSomething,這樣的函數(shù)命名含義明確
比如: openFile, setName, addNumber...

- **如果是屬性命名,建議使用定語(yǔ)+名詞**

比如 fileName, maxLength, textSize

不要單詞+拼音混合使用
比如:useJiFen,huKouNumber.. 缺乏美感不說(shuō),可讀性大幅度降低。

謹(jǐn)慎使用縮寫(xiě)
除非是約定俗成已經(jīng)被廣泛使用的縮寫(xiě),否則老老實(shí)實(shí)用完整拼寫(xiě)。典型的反面例子: count->cnt, manager->mgr password->pwd button->btn無(wú)論我們使用eclipse 或者intellij, 都有很好的自動(dòng)完成功能,名字長(zhǎng)一點(diǎn)沒(méi)關(guān)系的,可讀性更重要。

命名的語(yǔ)義話(動(dòng)詞、名詞的區(qū)分) Vue 組件命名
Ant.design 的 React 組件是下面這樣的時(shí)候,我感覺(jué)到一種自由的味道。首先,組件名可以使用原生 HTML 標(biāo)簽名,意味著再也不用較勁腦汁去規(guī)避原生 HTML 標(biāo)簽了。另外,這些組件都使用了首字母大寫(xiě)標(biāo)簽名,使它們很容易地與原生小寫(xiě)的 HTML 標(biāo)簽區(qū)分。
ReactDOM.render(
  
, mountNode );
基礎(chǔ)組件命名

應(yīng)用特定樣式和約定的基礎(chǔ)組件 (也就是展示類(lèi)的、無(wú)邏輯的或無(wú)狀態(tài)的組件) 應(yīng)該全部以一個(gè)特定的前綴開(kāi)頭,比如 Base、App 或 V。

**反例**
    components/
    |- button.vue
    |- loading.vue
    |- slide.vue
**正例**
    components/
    |- BaseButton.vue
    |- BaseLoading.vue
    |- BaseSlide.vue
單個(gè)活躍實(shí)例的組件

單個(gè)活躍實(shí)例的組件應(yīng)該以 The 前綴命名,以示其唯一性
這不意味著組件只可用于一個(gè)單頁(yè)面,而是每個(gè)頁(yè)面只使用一次。這些組件永遠(yuǎn)不接受任何 prop,因?yàn)樗鼈兪菫槟愕膽?yīng)用定制的,而不是它們?cè)谀愕膽?yīng)用中的上下文。如果你發(fā)現(xiàn)有必要添加 prop,那就表明這實(shí)際上是一個(gè)可復(fù)用的組件,只是目前在每個(gè)頁(yè)面里只使用一次。

**反例**
    components/
    |- SaleManage.vue
    |- ImportExcel.vue
**正例**
    components/
    |- TheSaleManage.vue
    |- TheImportExcel.vue
緊密耦合的組件名

和父組件緊密耦合的子組件應(yīng)該以父組件的命名為前綴.如果一個(gè)組件只在其父組件某個(gè)場(chǎng)景下有意義,這層關(guān)系應(yīng)該體現(xiàn)在組件名上,因?yàn)榫庉嬈魍ǔ0凑帐鬃帜疙樞蚪M織文件.

**反例**
    components/
    |- SearchBox.vue
    |- SearchItem.vue
    |- SearchButton.vue
**正例**
    components/
    |- SearchBox.vue
    |- SearchBoxItem.vue
    |- SearchBoxButton.vue
組件命中的單詞順序

組件名應(yīng)該以高級(jí)別的 (通常是一般化描述的) 單詞開(kāi)頭,以描述性的修飾詞結(jié)尾。

**反例**
    components/
    |- ClearSearchButton.vue
    |- ExcludeFromSearchInput.vue
    |- LaunchOnStartupCheckbox.vue
    |- RunSearchButton.vue
    |- SearchInput.vue
    |- TermsCheckbox.vue
**正例**
    components/
    |- SearchButtonClear.vue
    |- SearchButtonRun.vue
    |- SearchInputQuery.vue
    |- SearchInputExcludeGlob.vue
    |- SettingsCheckboxTerms.vue
    |- SettingsCheckboxLaunchOnStartup.vue
完整單詞的組件名

編輯器中的自動(dòng)補(bǔ)全已經(jīng)相當(dāng)友好,讓書(shū)寫(xiě)長(zhǎng)的組件名的代價(jià)已經(jīng)可以微乎其微,同樣的效率更易于理解,何樂(lè)而不為?

**反例**
    components/
    |- soManage.vue
    |- woManage.vue
**正例**
    components/
    |- SaleOrderManage.vue
    |- WorkOrderManage.vue
prop的大小寫(xiě)

在聲明時(shí)始終采用(camelCase),在模板和 JSX 中應(yīng)該始終使用( kebab-case)。
單純的遵循每個(gè)語(yǔ)言的約定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中則是 kebab-case。

**反例**
props: {
  "greeting-text": String
}

**正例**
props: {
  greetingText: String
}

vue中變量命名規(guī)范

變量命名使用主要集中在data和methods中

data中更多的是名詞與狀態(tài)布爾類(lèi)型

名詞:名詞太多,大致分為復(fù)數(shù)、后綴加Arr、加Obj之類(lèi)作為約定規(guī)則
狀態(tài)布爾型:

1.表示是不是,用is+ :如 isEmpty

表示有沒(méi)有,用has+... : 如 hasClass

表示能不能,用can+... :如 canSubmit

單詞本身的形式(過(guò)去式、進(jìn)行時(shí)、將來(lái)時(shí)):had開(kāi)頭、ing、ed結(jié)尾等

methods中handle+以下:

dd/remove,添加/移除
add/delete,添加/刪除
insert/delete,插入/刪除
start/stop,開(kāi)始/停止
begin/end,開(kāi)始/結(jié)束
send/receive,發(fā)送/接收
get/set,取出/設(shè)置
get/release,獲取/釋放
put/get,放入/取出
up/down,向上/向下
show/hide,顯示/隱藏
open/close,打開(kāi)/關(guān)閉
increment/decrement,增加/減少
lock/unlock,鎖/解鎖
next/previous,下一個(gè)/前一個(gè)
create/destroy,創(chuàng)建/銷(xiāo)毀
min/max,最小/最大
visible/invisible,可見(jiàn)/不可見(jiàn)
pop/push,出棧/入棧
store/query,存儲(chǔ)/查詢(xún)

結(jié)合業(yè)務(wù):
表單提交:submit、send
表單增刪改查:add、delete、update、search、reset
上傳附件:upload
關(guān)閉打開(kāi)彈窗:open/close
檢查:check

參考鏈接

CSS命名方式=》BEM
如何定義一個(gè)好的變量名
理解CSS命名規(guī)范--BEM
聊聊 Vue 組件命名那些事
談?wù)労瘮?shù)的命名規(guī)范
vue組件命名指南,不為取名而糾結(jié)

文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址:http://systransis.cn/yun/94641.html

相關(guān)文章

  • PHP開(kāi)發(fā)編碼規(guī)范

    摘要:本規(guī)范只針對(duì)開(kāi)發(fā)過(guò)程中編碼的規(guī)范,對(duì)于開(kāi)發(fā)項(xiàng)目中文件目錄數(shù)據(jù)庫(kù)等方面的規(guī)范,將不重點(diǎn)涉及。本規(guī)范包含了開(kāi)發(fā)時(shí)程序編碼中命名規(guī)范代碼縮進(jìn)規(guī)則控制結(jié)構(gòu)函數(shù)調(diào)用函數(shù)定義注釋包含代碼標(biāo)記文件頭的注釋塊標(biāo)記樣例常量命名等方面的規(guī)則。 第一章 編碼規(guī)范 為了更好的提高技術(shù)部的工作效率,保證開(kāi)發(fā)的有效性和合理性,并可最大程度的提高程序代碼的可讀性和可重復(fù)利用性,指定此規(guī)范。開(kāi)發(fā)團(tuán)隊(duì)根據(jù)自己的實(shí)際情...

    kycool 評(píng)論0 收藏0
  • Java編程風(fēng)格學(xué)習(xí)(三)

    摘要:在上一篇的編程風(fēng)格學(xué)習(xí)二中我們學(xué)習(xí)了一些在編碼過(guò)程中的格式規(guī)范,遵循這些規(guī)范毋庸置疑是我們的書(shū)寫(xiě)高質(zhì)量代碼的前提與基礎(chǔ)。二語(yǔ)言編程規(guī)范常量命名常量的每個(gè)單詞均大寫(xiě),單詞之間使用下劃線連接。方法表示動(dòng)作,采用動(dòng)詞命名。 在上一篇的java編程風(fēng)格學(xué)習(xí)(二)中我們學(xué)習(xí)了一些在Java編碼過(guò)程中的格式規(guī)范,遵循這些規(guī)范毋庸置疑是我們的書(shū)寫(xiě)高質(zhì)量代碼的前提與基礎(chǔ)。今天我們更進(jìn)一步,一起來(lái)學(xué)習(xí)J...

    CoderDock 評(píng)論0 收藏0
  • JavaScript 編碼規(guī)范

    摘要:這樣的變量增加了代碼量,并且混淆讀者。錯(cuò)誤代碼示例變量雖然聲明了,但沒(méi)被使用持續(xù)更新 JavaScript 編碼規(guī)范 一、命名規(guī)范 1. 變量 命名方法:小駝峰式命名法(由小寫(xiě)字母開(kāi)始,后續(xù)每個(gè)單詞首字母都大寫(xiě)) 命名建議:語(yǔ)義化的名詞 特殊:布爾值變量建議添加符合其含義的前綴動(dòng)詞 is:是否 can:能不能 has:有沒(méi)有 示例: // 頁(yè)面標(biāo)題 let pageT...

    wenshi11019 評(píng)論0 收藏0
  • PHP編碼規(guī)范

    摘要:為什么需要編碼規(guī)范為了提高工作效率,保證開(kāi)發(fā)的有效性和合理性。在文件編碼中,選擇推薦在換行符中,選擇推薦文件命名程序的文件名和目錄名都采用有意義的英文命名。最后最后說(shuō)的是,本規(guī)范不是強(qiáng)制,也不是標(biāo)準(zhǔn)。回復(fù)編碼規(guī)范即可。 為什么需要編碼規(guī)范? 為了提高工作效率,保證開(kāi)發(fā)的有效性和合理性。 為了提高代碼可讀性和可重復(fù)利用性,從而節(jié)約溝通成本。 本文主要參考了 PEAR 規(guī)范,并進(jìn)行適當(dāng)...

    xuweijian 評(píng)論0 收藏0
  • [前端開(kāi)發(fā)]--分享個(gè)人習(xí)慣的命名方式

    摘要:最近在知乎上看到這個(gè)作為程序員,有沒(méi)有讓你感到既無(wú)語(yǔ)又崩潰的程序命名。今天,也分享下最近自己在使用的命名習(xí)慣,當(dāng)然只是個(gè)人習(xí)慣。但是兩個(gè)函數(shù)的命名,一個(gè)是,另一個(gè)是。關(guān)于的命名規(guī)范,應(yīng)該很多人都是習(xí)慣用大駝峰命名。 把一件平凡的事情做好,很平凡。把一件平凡的事情堅(jiān)持的做好,很不平凡。 1.前言 如果說(shuō)計(jì)算機(jī)科學(xué)只存在兩個(gè)難題:緩存失效和命名。那么我就覺(jué)得命名的難點(diǎn)只有兩個(gè):詞匯量和堅(jiān)持...

    Rocture 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<