如何讓你的代碼易于維護(hù)的網(wǎng)站頁面代碼風(fēng)格指南
昔日的成都網(wǎng)站設(shè)計風(fēng)格指南通常被認(rèn)為是面向設(shè)計的文件重點(diǎn)品牌和顏色的使用。但隨著瘋狂的大型代碼庫的出現(xiàn)像臉譜網(wǎng)或谷歌的系列產(chǎn)品,風(fēng)格指南已經(jīng)演變。這些天,網(wǎng)站維護(hù)頁面代碼風(fēng)格指南風(fēng)格指南包含經(jīng)常更新文檔的當(dāng)前代碼庫及其使用情況。這些文件我們可以寫更多的可維護(hù)性和可重用的代碼,如何優(yōu)化我們的代碼庫的瞬間看到的是。
在一個網(wǎng)站維護(hù)頁面代碼風(fēng)格指南風(fēng)格指南是什么?
網(wǎng)站維護(hù)頁面代碼風(fēng)格指南風(fēng)格指南類似于年長的同行;它們包含的logo和品牌信息,色彩的使用,以及大綱代碼的使用。代碼大綱部分,在那里你可以很容易地找到重復(fù)的或相似的代碼并優(yōu)化你的代碼,或已在使用中的視圖組件。大多數(shù)導(dǎo)游是展示一個“日志”式的方法,每一個代碼實(shí)例文件,或故意的模塊編碼記錄。
不僅這些指南側(cè)重于HTML和CSS,其他語言也可以像JavaScript和PHP模塊化性能。幾個實(shí)例的網(wǎng)站維護(hù)頁面代碼風(fēng)格指南風(fēng)格指南可以發(fā)現(xiàn)在GitHub,Mozilla,和MailChimp。正如你可以看到這些例子,有一個頁面或子網(wǎng)站顯示用例的代碼為每個組件的一側(cè)很常見。這使得它很容易去抓住他們你需要他們的時候,和陌生的設(shè)計者看到組件在一個互動的方式工作。
開始你自己的網(wǎng)站維護(hù)頁面代碼風(fēng)格指南
開始你自己的網(wǎng)站設(shè)計頁面代碼風(fēng)格指南風(fēng)格指南文檔從頭開始似乎令人生畏,特別是對于大的項(xiàng)目。但通常有需要去做時間的投資回報。大型項(xiàng)目的建設(shè),極大地受益于網(wǎng)站維護(hù)頁面代碼風(fēng)格指南資料網(wǎng)站風(fēng)格和代碼結(jié)構(gòu)。規(guī)模較小的項(xiàng)目有一個不太明顯,但有時還是值得的,你對時間的投資回報。在任何情況下,如果你工作在一個項(xiàng)目,可能有一天會被轉(zhuǎn)交給另一個設(shè)計師或開發(fā)人員可以使他們的一天看到這樣的文件。
你經(jīng)常使用的組件是一種網(wǎng)站維護(hù)頁面代碼風(fēng)格指南方式指導(dǎo)使用情況下,按鈕立即浮現(xiàn)在腦海中。短名單的事情,你可能要考慮記錄布局選項(xiàng)(可能概述網(wǎng)格系統(tǒng)),排版,色彩的使用,按鈕和鏈接方式,形成造型,通知或提醒,和列表樣式。什么都可以被重用的好處可以說基本上。在概述,記得保持靈活。沒有風(fēng)格的警報或按鈕的特定的一個頁面或使用的情況下,除非絕對必要的。相反,添加改性劑類建立在諸如顏色、字體的基礎(chǔ),或?qū)徝赖淖兓_@樣,你可以指望。按鈕類指定一個一致的寬度,高度,和文本的大小而使改性劑類來改變特定的每個用例的東西。
可維護(hù)代碼的目標(biāo)
可維護(hù)代碼的目的是使事情可重用的和未來的證明。成分如公告欄,按鈕,標(biāo)題,頁腳,是可重用的代碼–事情你可以多次使用整個網(wǎng)站的很好的例子,或在同一頁上。如果你打破舊的或已經(jīng)寫好的代碼使它的事實(shí)后更易維護(hù),其實(shí)很簡單。開始剝離下來的CSS基礎(chǔ)知識。你應(yīng)該離開一個組件類定義結(jié)構(gòu)如高度,寬度,和位置。而其他改性劑類可以用來改變顏色或字體的審美之類的東西。另外,如果您的項(xiàng)目使用的是身體的ID或類為每個頁面,你可以風(fēng)格獨(dú)特的用例按頁這樣。千萬不要采取這種做法太多了,因?yàn)樗梢院苋菀椎靥砑?/p>
這個KISS原則是一個設(shè)計原則適用于模塊化的發(fā)展過程和。寫簡單的、可維護(hù)的代碼通常是通過保持你的組件簡單容易。說到簡單,如果使事情更有效和/或使用更少的代碼,同時實(shí)現(xiàn)相同的結(jié)果,它是可能的,我們的零部件應(yīng)寫做。一個可維護(hù)的代碼結(jié)構(gòu)的最終目標(biāo),是有一些可重用的,小的,遠(yuǎn)遠(yuǎn)比不維護(hù)更高效。
在CSS的命名約定
當(dāng)它涉及到一個維護(hù)的代碼結(jié)構(gòu),命名規(guī)則變得非常重要。寫描述性的CSS類,可以使維護(hù)代碼將一個簡單的任務(wù)。有沒有限制CSS類的長度,所以要利用你的優(yōu)勢。一定要堅持一個明確的命名慣例雖然混合破折號和下劃線或駱駝的情況下對所有小寫的名字容易混淆。它使你的組件類定義通常是一個好主意,使改性劑類較少。下面是一個按鈕的例子,一個獨(dú)特的使用規(guī)則,以及改性劑類。
自動化解決方案
自動式引導(dǎo)發(fā)電機(jī)已開始出現(xiàn)左,幫助推動正確的風(fēng)格指南。風(fēng)格原型是由李察和梅森SASS發(fā)生器內(nèi)存溫德爾建團(tuán)隊(duì)的青菜。這是一個更好的選擇,眼下,類似發(fā)電機(jī)一樣全息圖,嘉利,styledocco,和KSS也證明是有用的。
自動和手工制作
一如既往的,有使用方法的利弊。自動化解決方案是快速和可應(yīng)用的事實(shí)后,但他們有時也嚴(yán)格。手工制作的風(fēng)格指南讓你知道一切的來龍去脈,但需要更多的時間。就我個人而言,手工制作的方法,在大多數(shù)情況下,我是在與其他開發(fā)人員的工作條件最靈活。但它肯定是值得花時間去嘗試一些自動化的解決方案,只是為了讓他們?nèi)绾喂ぷ鞯南敕ê退麄兯f的關(guān)于你的代碼。
回顧你的代碼
網(wǎng)站都沒有完成。我們修改的東西,新的風(fēng)格和趨勢的轉(zhuǎn)變,而最終我們能最終從過去的很多代碼。重要的是花一點(diǎn)時間看看“端”的每個修改確定事情可以像他們那樣干凈。在這一點(diǎn)上,我也喜歡把每個組件(和改性劑類)在CodePen測試瀏覽器的支持和做筆記,因此。這可以節(jié)省大量時間后,如果你是一個支持的限制,網(wǎng)頁設(shè)計。在回顧,也一定要留意成分可能彼此沖突,以奇特的方式或使盒模型的問題。
結(jié)論
總之,風(fēng)格指南應(yīng)該導(dǎo)致代碼非常手法靈活,但仍易于維護(hù)和讀取??紤]到我們必須投資達(dá)到這樣的結(jié)果多少時間,生活風(fēng)格指南有一個更大的項(xiàng)目可量化的影響比較小。復(fù)雜或大型項(xiàng)目中受益很多,所有的優(yōu)化和性能的提高,這是很值得花時間達(dá)到說結(jié)果。創(chuàng)造一種生活方式指導(dǎo)一個小網(wǎng)站或項(xiàng)目不可能證明的時間雖然值得投資。