摘要:如何高效的命名你的項目。在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一個良好的命名規范的重要性,同時在項目中也會遇到一些命名的瓶頸。當命名的構造函數和類使用。
如何高效的命名你的項目。
在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一個良好的命名規范的重要性,同時在項目中也會遇到一些命名的瓶頸。所以有必要寫一篇關于常見命名的方式。以下是通過3年的編程經驗,以及參考網上知名的開源項目總結的一點經驗。希望共勉
1.文件夾命名1.最好用一個單詞描述
常用項目命名 | omi、element、master、project、test、vue、iview |
---|---|
二級目錄 | build、static、config、src、examples、base、common、issues、assert |
三級目錄 | libs、models、plugins、skins、images、css、js |
2.如果一個單詞描述不了,用2個詞(名詞加動詞)
color-pick、button-groups、date-picker、option-grounp、jquery-select、jquery-swiper
3.中間用-或者_連接為了方便歸類、一目了然
2.文件命名node_models、async-demo、array-union、array-differ、babel-each。
1.最好用一個單詞描述
以下變量名可以加css、js、html,例如index.html、index.js、index.css。
常用組件命名 | index、message、menu、slider(滑塊)、page、progress(進度條)、tooltip(提示)、tree、upload、time、button、checkbox、dialog、cascader(三級聯動) |
---|---|
常用文件命名 | index、shopping(購物)、 share(分享)、integral(積分)、advertisement(廣告)、pay(支付)、community(社區)、game、docs、bussiness |
2.如果一個單詞描述不了,用2個詞(名詞加動詞)
share-to-friends,share-to-community,weex-pay,alipay-pay,user-integral,
game-page,docs-page等等反正就是自我想象。
3.中間用-或者_連接為了方便歸類、一目了然
在目前做的pc端和移動端,簡單的對他們分個類:
1.移動廣告(mobile-advertisement)
2.移動社交(mobile-social)
3.移動電子商務(mobile-bussiness)
4.手機游戲(mobile-game)
5.手機電視(mobile-tv)
6.移動電子閱讀(mobile-reading)
7.手機搜索(mobile-search)
8.移動支付(mobile-pay)
9.手機內容共享(mobile-share)
關于以上的項目都可以用名詞+需要的動詞命名,達到見詞知意
3.html布局命名可以參考DIV+CSS規范命名大全集合但是我覺得寫的并不是很好,很全面。因為往往比較糾結的是每一個大布局中小布局的命名。
外套 wrap | #container |
---|---|
頭部 header | #head, #header,#nav,#sub-nav,#menu, #sub-menu,#branding |
主要內容 main | bussiness-title 、bussiness-logo、bussiness-search、bussiness-search-results |
左側 main-left | #side-bar, #side-bar-a, #side-bar-b |
右側 main-right | #side-bar, #side-bar-a, #side-bar-b |
內容 content | radio-click、radio-heightlight、radio-active、input-seach-off、input-search-on |
底部 footer | #service, #regsiter,#partner(合作伙伴),#joinus, #site-info |
總結
1.一般頭部有nav、nav-event、nav-style、nav-item、nav-link。
2.內容:xx-title、xx-box、xx-warp、xx-item、xx-item-title、xx-item-link、xx-item-image
3.底部:footer-time、footer-box、footer-item、footer-item-link、footer-address。總之xx-wrap,xx-box,xx-item、xx-link、xx-title、xx-total肯定會滿足你80%的需求
4.js變量命名1.基礎類型和引用數據類型
基礎類型
字符串var s_count="",
布爾類型var b_status=false,
數字類型var n_total=12。
引用數據類型
數組var ar_bar=[],
對象var o_bar={},
函數var f_submit=function(){}
2.不要用關鍵字命名default、class、private
3.用可讀的同義詞代替保留詞。
// bad var superman = { class: "alien" }; // bad var superman = { klass: "alien" }; // good var superman = { type: "alien" };
4.函數用駝峰形式(動詞+名詞)
login(),logout(),expandList(),getTotal(),keySearch(),submitForm(),cancel(),goMore(),searchAll>(),searchCurrent().clearContent().uploadImage().searchResult()這些都是常用事件,可以清晰知道每一項的意義。
5.當命名的構造函數和類使用PascalCase。
// bad function user(options) { this.name = options.name; } var bad = new user({ name: "nope" }); // good function User(options) { this.name = options.name; } var good = new User({ name: "yup" });
6.不要使用尾隨或前導下劃線。
// bad this.__firstName__ = "Panda"; this.firstName_ = "Panda"; this._firstName = "Panda"; // good this.firstName = "Panda";
6.前綴jQuery對象變量與$。
// bad var sidebar = $(".sidebar"); // good var $sidebar = $(".sidebar"); // bad $("ul", ".sidebar").hide(); // bad function setSidebar() { $(".sidebar").hide(); // ...stuff... $(".sidebar").css({ "background-color": "pink" }); } // good function setSidebar() { var $sidebar = $(".sidebar"); $sidebar.hide(); // ...stuff... $sidebar.css({ "background-color": "pink" }); } // bad $(".sidebar").find("ul").hide(); // good $(".sidebar ul").hide(); // good $(".sidebar > ul").hide(); // good $sidebar.find("ul").hide();5.css命名
公共的 | common.css |
---|---|
其實和common差不多 | base.css |
動畫 | animation.css |
皮膚 | skin.css |
文字 | font.css |
主題 | themes.css |
打印樣式 | print.css |
顏色 | color.css |
1、第一部分是圖片的邏輯歸屬分類
2、第二部分是圖片的表現內容
3、第三部分是圖片的內容的類型(有些圖片還會有第四部分,表示圖片表現的狀態。)
4、tabbar_home_icon, navigationbar_showtime_icon@2x.png,tabbar_categories_icon
7.分享demo1.餓了么部分組織構架
2.騰訊omi
es5的語法規范
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/50584.html
摘要:如何高效的命名你的項目。在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一個良好的命名規范的重要性,同時在項目中也會遇到一些命名的瓶頸。當命名的構造函數和類使用。 如何高效的命名你的項目。 在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一...
摘要:如何高效的命名你的項目。在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一個良好的命名規范的重要性,同時在項目中也會遇到一些命名的瓶頸。當命名的構造函數和類使用。 如何高效的命名你的項目。 在做一個項目的時候,我們往往遭遇命名問題的困惑,當看到一些非專業人的代碼,看到他們凌亂的碼法,有時候真的苦不堪言。深刻知道一...
閱讀 1823·2021-09-28 09:46
閱讀 3143·2019-08-30 14:22
閱讀 1878·2019-08-26 13:36
閱讀 3343·2019-08-26 11:32
閱讀 2081·2019-08-23 16:56
閱讀 1151·2019-08-23 16:09
閱讀 1303·2019-08-23 12:55
閱讀 2148·2019-08-23 11:44