小程序項(xiàng)目結(jié)構(gòu)和代碼規(guī)范

一個(gè)清晰的項(xiàng)目結(jié)構(gòu)有助于我們快速毁欣、高效的開發(fā)項(xiàng)目昭躺,也有助于團(tuán)隊(duì)快速了解項(xiàng)目则果。這是我寫小程序的一些規(guī)范總結(jié)幔翰。

一、 項(xiàng)目結(jié)構(gòu)

  .
├── app.js
├── app.json
├── app.wxss      
├── assets (項(xiàng)目資源文件存放文件夾)
│   └── images(項(xiàng)目本地圖片存放文件夾)
│
├── components (自定義組件存放文件夾)
│   ├── custom-button
│   ├── ...
│   └── custom-navigation
│
├── pages  (頁(yè)面文件存放文件夾)
│   ├── home
│   ├── ...
│   └── mine
│
├── requests (項(xiàng)目所有網(wǎng)絡(luò)請(qǐng)求存放文件夾)
│   └── index.js  
│
├── statics (項(xiàng)目通用文件夾短条,方便直接在多個(gè)新的項(xiàng)目中使用)
│   ├── config   (項(xiàng)目配置)
│   │   └── index.js
│   │
│   ├── crypto  (項(xiàng)目AES加解密和MD5加密)
│   │   ├── AES.js (外部使用的加解密)
│   │   └── crypto.js
│   │
│   ├── fonts (項(xiàng)目引入的第三方字體)
│   │   └── font.wxss
│   │
│   ├── judgement (封裝常用判斷导匣,手機(jī)號(hào)、姓名茸时、身份證...)
│   │   └── index.js
│   │
│   ├── request (封裝常用判斷贡定,手機(jī)號(hào)、姓名可都、身份證...)
│   │   ├── index.js (主要網(wǎng)絡(luò)請(qǐng)求封裝)
│   │   ├── params.js(網(wǎng)絡(luò)請(qǐng)求參數(shù)封裝)
│   │   └── wxLogin.js (微信登錄相關(guān))
│   │
│   ├── router(常用的頁(yè)面跳轉(zhuǎn))
│   │   └── index.js
│   │
│   ├── storage (本地?cái)?shù)據(jù)緩存的key和相關(guān)的方法)
│   │   └── index.js
│   │
│   ├── toast(網(wǎng)絡(luò)請(qǐng)求提示和彈窗提示文字等方法)
│   │   └── index.js
│   │
│   ├── utils(常用的工具類方法)
│   │   └── util.js
│   │
│   └── wxs (小程序腳本語(yǔ)言文件缓待,這里主要處理了價(jià)格)
│       └── price.wxs
│
└── utils (系統(tǒng)默認(rèn)創(chuàng)建的當(dāng)前項(xiàng)目工具類文件)
    └── util.js 
 

二、 代碼規(guī)范(重點(diǎn))

  • 自定義組件(components)
  1. 文件夾名字統(tǒng)一用小寫字母;
  2. 文件夾多個(gè)單詞之間用“-”來連接渠牲,`如:custom-navigation;
  3. 文件名稱與文件夾名稱一致旋炒,如:custom-navigation.js;
  4. 多個(gè)地方使用可以考慮直接配置到app.json中的“usingComponents”里面。`

  • 頁(yè)面文件(pages)
  1. 文件夾第一個(gè)單詞使用小寫签杈,如:home;
  2. 多個(gè)單詞使用駝峰命名瘫镇,如:orderDetail;
  3. 文件名稱統(tǒng)一使用index.js鼎兽。
  • 工具類文件和其他(statics或utils)
  1. 文件夾第一個(gè)單詞使用 小寫,如:home;
  2. 多個(gè)單詞使用駝峰命名铣除,`如:orderDetail;
  3. 文件名稱統(tǒng)一使用index.js谚咬。
  • CSS規(guī)范
  1. css布局統(tǒng)一使用flex布局
  2. 尺寸單位統(tǒng)一使用rpx
  3. 命名采用“-”(雙擊不可復(fù)制)或者“_”(雙擊直接復(fù)制)來連接都可以。如: header-wraper, header_wraper.
  • JS規(guī)范
  1. js 的命名采用駝峰命名法;
  2. js語(yǔ)句無(wú)需寫 尚粘;來結(jié)尾择卦;
  3. js中一致使用 單引號(hào)''或者 反引號(hào)``,不是使用 雙引號(hào)"";
  4. wxml郎嫁、css秉继、json 中均使用雙引號(hào) ""
  5. 點(diǎn)擊事件名稱on+事件名稱或者業(yè)務(wù)名稱泽铛,能有知名思議的效果尚辑。如:onSelectTitle()
  • 函數(shù)
  1. pages的頁(yè)面文件中,系統(tǒng)方法仍使用默認(rèn)的方式厚宰,如: onLoad: function () {}, 自定義的方法統(tǒng)一使用如:函數(shù)名() {}
  2. 其他js文件使用const 函數(shù)名 = () => {} (不建議使用到pages的頁(yè)面文件中避免this指向問題), 或者 函數(shù)名(){}
  3. 異步回調(diào)函數(shù) 統(tǒng)一使用 Promise
  • 文件的導(dǎo)入和導(dǎo)出

1.文件導(dǎo)入:
1)使用微信引入模塊的方式腌巾,即 require(path) 相當(dāng)于整個(gè)模塊導(dǎo)入;
2)ES6方式導(dǎo)入,import xx from path 按需導(dǎo)入铲觉。

  1. 文件導(dǎo)出
    1)使用module.exports = {}方式模塊導(dǎo)出;
    2)使用 export單個(gè)導(dǎo)出 或者 export default {}導(dǎo)出多個(gè)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末吓坚,一起剝皮案震驚了整個(gè)濱河市撵幽,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌礁击,老刑警劉巖盐杂,帶你破解...
    沈念sama閱讀 217,509評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異哆窿,居然都是意外死亡链烈,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門挚躯,熙熙樓的掌柜王于貴愁眉苦臉地迎上來强衡,“玉大人,你說我怎么就攤上這事码荔′銮冢” “怎么了?”我有些...
    開封第一講書人閱讀 163,875評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵缩搅,是天一觀的道長(zhǎng)越败。 經(jīng)常有香客問我,道長(zhǎng)硼瓣,這世上最難降的妖魔是什么究飞? 我笑而不...
    開封第一講書人閱讀 58,441評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上亿傅,老公的妹妹穿的比我還像新娘媒峡。我一直安慰自己,他們只是感情好袱蜡,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,488評(píng)論 6 392
  • 文/花漫 我一把揭開白布丝蹭。 她就那樣靜靜地躺著,像睡著了一般坪蚁。 火紅的嫁衣襯著肌膚如雪奔穿。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,365評(píng)論 1 302
  • 那天敏晤,我揣著相機(jī)與錄音贱田,去河邊找鬼。 笑死嘴脾,一個(gè)胖子當(dāng)著我的面吹牛男摧,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播译打,決...
    沈念sama閱讀 40,190評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼耗拓,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了奏司?” 一聲冷哼從身側(cè)響起乔询,我...
    開封第一講書人閱讀 39,062評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎韵洋,沒想到半個(gè)月后竿刁,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,500評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡搪缨,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,706評(píng)論 3 335
  • 正文 我和宋清朗相戀三年食拜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片副编。...
    茶點(diǎn)故事閱讀 39,834評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡负甸,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出齿桃,到底是詐尸還是另有隱情惑惶,我是刑警寧澤,帶...
    沈念sama閱讀 35,559評(píng)論 5 345
  • 正文 年R本政府宣布短纵,位于F島的核電站带污,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏香到。R本人自食惡果不足惜鱼冀,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,167評(píng)論 3 328
  • 文/蒙蒙 一报破、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧千绪,春花似錦充易、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至瑞妇,卻和暖如春稿静,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背辕狰。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工改备, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蔓倍。 一個(gè)月前我還...
    沈念sama閱讀 47,958評(píng)論 2 370
  • 正文 我出身青樓悬钳,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親偶翅。 傳聞我的和親對(duì)象是個(gè)殘疾皇子默勾,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,779評(píng)論 2 354

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