小程序開發(fā)文檔規(guī)范

目錄規(guī)范

1.目錄概述

組件文件

所有組件相關(guān)文件統(tǒng)一放在components目錄下榨为。

圖片文件

項(xiàng)目圖片文件放置于根目錄的images文件夾下押袍,組件獨(dú)有的圖片放在當(dāng)前組件images目錄下

模型文件

模型文件主要用于編寫各類業(yè)務(wù)模型。項(xiàng)目模型文件放置于根目錄的models文件夾下铡原,組件相關(guān)模型放置于components目錄下的models文件夾中。

行為文件

行為文件放在所引用的組件目錄下。


WXML規(guī)范

1.?????WXML規(guī)范

wxml標(biāo)簽可以單獨(dú)出現(xiàn)的情況黍檩,盡量單獨(dú)出現(xiàn),如<input />始锚。

<input />

控制每行HTML的代碼數(shù)量在50個字符以內(nèi)刽酱,方便閱讀瀏覽,多余的代碼進(jìn)行換行處理瞧捌,標(biāo)簽所帶屬性每個屬性間進(jìn)行換行棵里。

<v-music

wx:if="{{classic.type===200}}"

img="{{classic.img}}"

content="{{classic.content}}"

</v-music>

合理展現(xiàn)分離內(nèi)容,不要使用內(nèi)聯(lián)樣式姐呐。

<image class="tag"></image>


2.?????注釋規(guī)范

除組件外的其他塊級元素殿怜,均需注釋出其功能,并在其上下空出一行與其他代碼進(jìn)行區(qū)分皮钠。

<view>...</view>

//導(dǎo)航欄

<view>...</view>

<view>...</view>

CSS規(guī)范

1.????CSS規(guī)范

在開發(fā)過程中rpx和px均可能用到稳捆,如通常情況下間距使用rpx,字體大小和邊框等使用px麦轰,開發(fā)者根據(jù)實(shí)際情況而定乔夯。

width: 100rpx;

font-size: 14px;

CSS代碼需有明顯的代碼縮進(jìn)。每一個樣式類之間空出一行款侵。

.v-tag{

? ? width: 100%;

}

.v-container{

? ? width: 100%;

}

盡量使用簡寫屬性末荐,并且同一屬性放置在一起,避免散亂新锈。

/**使用簡寫屬性**/

.v-image{

? ? margin: 0 auto;

}

/**同一屬性放在一塊**/

.v-tag{

? ? margin-left: 10rpx;

? ? margin-right: 10rpx

}

采用flex進(jìn)行布局甲脏,禁止使用float以及vertical-align。

.container{

? ? disaplay: flex;

? ? flex-dirextion: row

}

2.?????注釋規(guī)范

成組的wxss規(guī)則之間用塊狀注釋。請勿在代碼后面直接注釋块请。

/** 修改button默認(rèn)的點(diǎn)擊態(tài)樣式類**/

.button-hover {

? ? background-color: red;

}

JS規(guī)范

1.?????JS規(guī)范

命名規(guī)范

變量名以及函數(shù)名統(tǒng)一采用駝峰命名法娜氏,正常情況下函數(shù)名前綴需加上清晰的動詞表示函數(shù)功能,私有函數(shù)或者屬性以下劃線開頭表明墩新。常量需用const 聲明贸弥。

類的命名首字母需大寫。

采用ES6 關(guān)鍵字let定義變量海渊,盡量不使用var

//定義常量

const a = 1

//定義變量

let imageContent = res.data

//函數(shù)命名

getInfo:function(){

? ? return '';

}

//私有函數(shù)

_getInfo:function(){

? ? return '';

}

回調(diào)函數(shù)規(guī)范

回調(diào)函數(shù)統(tǒng)一使用Promise函數(shù)的方式進(jìn)行編寫绵疲,回調(diào)成功的參數(shù)統(tǒng)一為res,錯誤參數(shù)為err臣疑。

// promise 處理回調(diào)

let back = new Promise((resolve, reject) => {

? ? if (/* 異步操作成功 */){

? ? ? ? resolve(value);

? ? } else {

? ? ? ? reject(error);

? ? }

});

back.then((res) => {

? ? ? console.log('成功回調(diào)盔憨!', res);

? ? }).catch((err) => {

? ? ? console.log('失敗回調(diào)!', error);

});

私有函數(shù)以及回調(diào)函數(shù)統(tǒng)一放置在生命周期函數(shù)后讯沈。

刪除js文件中未用到的生命周期函數(shù)郁岩,保持代碼的整潔。

Pages({

? ? data:{

? ? },

? ? onLoad:function(event){


? ? },

? ? _self:function(){

? ? }

})

每個函數(shù)之間用一個空行分離結(jié)構(gòu)芙盘。

數(shù)據(jù)綁定變量定義規(guī)范

所有涉及到數(shù)據(jù)綁定的變量均需在data中初始化驯用。禁止在不定義的情況下直接setData脸秽。

Pages({

? ? data:{

? ? ? ? id : null

? ? },

? ? onLoad:function(event){

? ? ? ? let id = event.target.dataset.id

? ? ? ? this.data.id = id

? ? }

})

點(diǎn)擊事件規(guī)范

點(diǎn)擊事件函數(shù)命名方式為 on + 事件名 或者業(yè)務(wù)名儒老。

onLike: function(event){

}

組件規(guī)范

組件名命名規(guī)范

組件在使用時命名以 “v-”為開頭的組件名,若組件名稱為多個單詞名拼接而成记餐,采用 ' - ' 連接驮樊。組件標(biāo)簽在page頁面使用時推薦使用單閉合標(biāo)簽(此條約束對于包含有slot的組件無效)

v 來源于法語 單詞 ‘vent’ @林間有風(fēng)

<v-movies />

觸發(fā)事件規(guī)范

組件點(diǎn)擊觸發(fā)事件建議用冒號分隔開

<v-component-tag-name bind:myevent="onMyEvent" />

externalClasses命名規(guī)范

命名格式采用如下形式:v-class-{name},name可自行定義

v-class-icon


組件樣式規(guī)范

所有組件樣式均應(yīng)采用類的寫法片酝,且命名必須以 v- 開頭囚衔,不允許使用內(nèi)聯(lián)樣式以及id樣式

.v-container{

? ? disaplay: flex;

? ? flex-dirextion: row

}

標(biāo)點(diǎn)規(guī)范

JS語句無需以分號結(jié)束,統(tǒng)一省略分號

JS中一致使用反引號 ``或單引號' ' , 不使用雙引號雕沿。

WXML练湿、CSS、JSON中均應(yīng)使用雙引號审轮。

CSS屬性中冒號中后面用一個空格分隔開肥哎。

————————————————

原文鏈接:https://blog.csdn.net/qq_29920751/article/details/87623435

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市疾渣,隨后出現(xiàn)的幾起案子篡诽,更是在濱河造成了極大的恐慌,老刑警劉巖榴捡,帶你破解...
    沈念sama閱讀 216,744評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件杈女,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)达椰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,505評論 3 392
  • 文/潘曉璐 我一進(jìn)店門翰蠢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人啰劲,你說我怎么就攤上這事燎窘±晕Γ” “怎么了?”我有些...
    開封第一講書人閱讀 163,105評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長瓦呼。 經(jīng)常有香客問我,道長切威,這世上最難降的妖魔是什么伍宦? 我笑而不...
    開封第一講書人閱讀 58,242評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮啃憎,結(jié)果婚禮上芝囤,老公的妹妹穿的比我還像新娘。我一直安慰自己辛萍,他們只是感情好悯姊,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,269評論 6 389
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著贩毕,像睡著了一般悯许。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上辉阶,一...
    開封第一講書人閱讀 51,215評論 1 299
  • 那天先壕,我揣著相機(jī)與錄音,去河邊找鬼谆甜。 笑死垃僚,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的规辱。 我是一名探鬼主播谆棺,決...
    沈念sama閱讀 40,096評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼罕袋!你這毒婦竟也來了改淑?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,939評論 0 274
  • 序言:老撾萬榮一對情侶失蹤炫贤,失蹤者是張志新(化名)和其女友劉穎溅固,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體兰珍,經(jīng)...
    沈念sama閱讀 45,354評論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡侍郭,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,573評論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片亮元。...
    茶點(diǎn)故事閱讀 39,745評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡猛计,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出爆捞,到底是詐尸還是另有隱情奉瘤,我是刑警寧澤,帶...
    沈念sama閱讀 35,448評論 5 344
  • 正文 年R本政府宣布煮甥,位于F島的核電站盗温,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏成肘。R本人自食惡果不足惜卖局,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,048評論 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望双霍。 院中可真熱鬧砚偶,春花似錦、人聲如沸洒闸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,683評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽丘逸。三九已至单鹿,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間鸣个,已是汗流浹背羞反。 一陣腳步聲響...
    開封第一講書人閱讀 32,838評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留囤萤,地道東北人。 一個月前我還...
    沈念sama閱讀 47,776評論 2 369
  • 正文 我出身青樓是趴,卻偏偏與公主長得像涛舍,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子唆途,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,652評論 2 354

推薦閱讀更多精彩內(nèi)容