Wordpress

Skoðaðu WordPress kóðunarstaðla nánar

Samkvæmt W3tech starfa 65.1% vefsíðna sem nota vefumsjónarkerfi á WordPress. Það er þekkt opinn uppspretta CMS skrifað á PHP tungumáli. Vegna fjölbreytts úrvals sérsniðinna þema og viðbóta nota margir SaaS veitendur og stafrænar markaðsstofur WordPress til að búa til vefsíður.

Hvers vegna kynnti WordPress kóðunarstaðla?

Þar sem WordPress er gríðarlegur opinn hugbúnaður samanstendur hann af risastórum frumkóða til að keyra. Þetta er vegna framlags nokkurra þróunaraðila til þessa dags. Þar sem erfðaskrá er hægt að gera í mörgum stílum gætu verktaki bætt hvers kyns kóða sem þeir þekkja á WordPress pallinn. Þetta getur leitt til fylgikvilla fyrir WordPress.

Ef margir kóðunarstílar væru innleiddir í frumkóðann WordPress, þá væri það flókið sem það yrði fyrir mismunandi hugbúnaðarframleiðendur að lesa og stækka forrit hugbúnaðarins. Starfsmenn DevOps sem skanna í gegnum mismunandi kóðastíla ættu erfitt með að bera kennsl á villur. Þetta getur valdið því að vefsíður hrynji við opnun, sem veldur tjóni hvað varðar tap viðskiptavina til fyrirtækja.

Til að koma í veg fyrir slíkar aðstæður kynnti WordPress kóðunarstaðla. Þetta var sett af reglugerðum sem er skylt fyrir forritara að fylgja þegar virkni WordPress er útvíkkuð.

Kóðunarstaðlar einfalda ferlið við meðhöndlun og mat á magni kóðasýna. Þetta er vegna þess að þeir fylgja sömu sniðstílum, sem gerir það auðveldara fyrir mismunandi forritara að skilja hvað er að gerast í frumkóðann. Á heildina litið hjálpa kóðunarstaðlar við að viðhalda gæðum frumkóða sem aðrir forritarar leggja til.

Hvaða kóðunarstaðla notar WordPress?

WordPress er ekki eingöngu háð PHP tungumálinu. Það notar einnig HTML, CSS og JavaScript. Þannig eru kóðunarstaðlar þess mismunandi eftir þessum forritunarmálum. Ef þú hlakkar til að búa til þitt eigið WordPress viðbót og bæta WordPress pallinn, þá eru hér kóðunarstaðlarnir sem þú þarft að fylgja þegar þú býrð til kóðann þinn.

1. Kóðun með PHP

Fyrir framlag einsleitrar, hreinnar og skiljanlegrar kóðun, kynnti WordPress kóðunarstaðla fyrir PHP álagningu. Ef þú ert að gera einhver WordPress verkefni í gegnum PHP merkingu, fylgdu eftirfarandi kóðunarreglum.

  • Notkun tilvitnana

WordPress mælir með því að nota tvöfaldar og stakar gæsalappir við viðeigandi aðstæður. Hægt er að nota stakar gæsalappir inni í streng þegar ekkert er metið. Þegar þú notar gæsalappir skaltu panta einn gæsalappastíl til notkunar inni í streng og hinn til að umlykja allan strenginn.

Ekki er hvatt til að sleppa tilvitnunum í streng.

  • Inndráttur

Þegar inndráttur er notaður leggur WordPress áherslu á að nota flipalykla frekar en billykla til að tákna inndregnar kóðalínur. Kosturinn við þetta er að kóðinn þinn verður samhæfður við mismunandi ritstjóra sem nota hann á mismunandi kerfum.

Inndráttur hjálpar rökréttum svæðum kóðans þíns að skera sig úr, sem gerir þau skýr og skiljanleg

Ef þú ert að nota tengd fylki og það inniheldur marga hluti, ætti hver hluti af því fylki að hafa sína eigin nýja línu. Í lok síðasta atriðisins í fylkinu þínu skaltu bæta við kommu. Þetta gerir það auðveldara að bæta nýjum þáttum inn í fylkið eða breyta röð þess.

  • PHP merki

Þegar PHP kóðabútar eru notaðir í HTML kubbum ættu PHP opna og loka merkin að vera á sérstakri línu fyrir sig.

WordPress bannar að nota skammstafað PHP merki þar sem þau geta valdið vandamálum meðan þú keyrir kóðann þinn.

  • axlabönd

WordPress gerir það skylt að nota axlabönd í kóðanum þínum. Opnunarspelku verður að setja í línu upphafssetningar. Einungis er sleppt axlaböndum fyrir einlínu yfirlýsingar. Lykkjuyfirlýsingar verða einnig að innihalda axlabönd. Ef verið er að nota fjölblokka staðhæfingar, þá eru axlabönd nauðsynleg.

  • Notkun pláss

Pláss verður að setja á báðar hliðar úthlutunar, rökrænna, samanburðar- og strengjaaðgerða og á eftir kommum. Einnig þarf að setja pláss eftir opnun og áður en svigum er lokað, að undanskildum gerðum. Eyða verður aftan bilum í lok hverrar kóðalínu.

  • SQL staðhæfingar

Kóðunarstaðlar WordPress hvetja til að skrifa SQL staðhæfingar með hástöfum. Þessar staðhæfingar má skrifa í einni línu svo framarlega sem þær eru stuttar og auðlesnar. Fyrir flóknar SQL fyrirspurnir er ráðlagt að skipta þeim í margar línur og draga inn hverja SQL setningu.

  • Nafnareglur

Hönnuðir þurfa að fylgja WordPress reglugerðum á meðan þeir nefna aðgerðir, flokka og skrár til að koma í veg fyrir sóðalegar villur. Þegar búið er til aðgerðir eða breytur verða nöfn að vera rituð með lágstöfum og camelCase er stranglega bannað. Ef mörg orð eru notuð þegar þau eru nefnd skaltu aðgreina þau með undirstrik.

Svipað er tilfellið fyrir skráarnöfn, nema að ef mörg orð eru notuð verða þau að vera aðskilin með bandstrik. Ef skráin þín samanstendur af flokki, þá verður skráarnafnið að vera skrifað á sniðinu class–class name með lágstöfum og hverjum undirstrik er skipt út fyrir bandstrik.

Ef verið er að lesa eða bæta skrám sem samanstanda af sniðmátsmerkjum í wp-includes möppunni, verður -sniðmát að bæta við það skráarnafn.

Þegar flokkar eru búnir til verða flokksnöfn að vera með hástöfum. Ef mörg orð eru notuð ættu þau að vera aðskilin með undirstrik og hvert orð þarf að vera með stórum staf.

2. Kóðun með HTML

Kóðunarreglur kveða á um að HTML kóða búta þurfi að keyra í gegnum W3C löggildingartækið áður en kóðinn er skoðaður handvirkt. Þetta hjálpar til við að koma auga á og laga allar álagningarvillur í kóðanum þínum. Fylgja þarf eftirfarandi stöðlum þegar bætt er við HTML-kóðun.

  • Sjálfslokandi merki

Fara þarf varlega með sjálflokandi merki í HTML, sérstaklega með bili. W3C gefur fyrirmæli um að pláss verði á undan sjálflokandi framskán þegar sjálflokandi merki eru notuð.

  • Merki og eiginleikar

Merki hjálpa til við að hanna uppbyggingu HTML síðu. Þeir umlykja vefinn innihalda og gera vafranum kleift að ákvarða hvers konar efni það er. Eiginleikar veita frekari upplýsingar um HTML þætti.

Kóðunarreglur WordPress mæla með því að öll HTML merki og eiginleikar þurfi að vera skrifaðir með lágstöfum. Eiginleikagildi verða einnig að skrifa með lágstöfum fyrir vélræna túlkun. Þegar um er að ræða að gera gögn læsileg fyrir menn er hægt að nota rétta hástafi.

  • Tilvitnanir

Tvöfaldar eða stakar gæsalappir eru nauðsynlegar til að nota þegar eigindgildi eru rituð í XHTML. Kóðunarstaðlar WordPress fyrir HTML mæla með sama sniði til að koma í veg fyrir öryggisvandamál í HTML kóðanum.

3. Kóðun með CSS

CSS er annað nauðsynlegt forritunarmál til að hanna útlit og þema vefsíðna þinna. WordPress kynnti kóðunarstaðla fyrir CSS kóðun svo að verktaki gæti búið til samræmdan, hreinan og læsilegan kóða fyrir verkefni. Hér eru ráðlagðar leiðbeiningar.

  • Uppbygging

 CSS býður upp á marga möguleika til að hanna stílblaðið þitt. Hins vegar veitir WordPress grunnleiðbeiningar í CSS til að búa til skýran og áberandi kóða. Þetta hjálpar öðrum forriturum að vinna með þér til að skilja flæði skjalsins þíns.

Leiðbeiningarnar ráðleggja því að nota flipa til að draga inn allar eignir sem notaðar eru í kóðanum þínum. Kóðunarkubbar sem tilheyra sama hluta verða að hafa eitt auðlínubil á milli hverrar blokkar. Til að greina kóðunarhluta þarf að bæta 2 auðum línum á milli hverrar kóðunarhluta.

Ef þú ert að skrá marga veljara fyrir eitt reglusett verður að skrifa hvern veljara í sérstaka línu. Fyrir eignagildispör ætti hvert að hafa sína eigin línu, nota einn inndráttarflipa og enda með semíkommu. Þegar aðeins er notað einn veljara verður að setja opnunarspelku í línu þess vals.

Að öðrum kosti ætti að bæta opnunarspelkunni við í línu síðasta vals og lokastífinu í sérstakri línu í sömu innstungu og opnunarstýrið.

  • Kjósendur

Kóðunarstaðall fyrir veljara er svipaður og PHP kóðunarstaðlar fyrir skráarnöfn. Þegar veljara eru nefndir verða þeir að vera skrifaðir með lágstöfum og bandstrik verður að nota til að aðgreina mörg orð. Notkun á camelCase og undirstrikum er bönnuð.

Valnöfn ættu að geta gefið stutta lýsingu á hvaða þáttum þeir stíla. Þessi nöfn ættu að vera læsileg fyrir menn. Fyrir eigindaveljara verður að setja tvöfaldar gæsalappir utan um gildi þeirra.

  • Eiginleikar

WordPress dregur úr notkun tiltekinna eiginleika sem geta valdið því að sveigjanleiki hönnunarinnar minnkar. Kóðunarstaðall þess ráðleggur að hverri eign þurfi að fylgja tvípunktur og bil.

Eiginleikar og gildi verða að vera skrifuð með lágstöfum, nema leturnöfn. Til að bæta við litum er ákjósanlegur hexkóði eða rgba() og það verður að nota lágstafi. Mælt er með notkun stuttmyndareiginleika fyrir bakgrunn, ramma, leturgerð, listastíl, spássíu og fyllingu.

4. Kóðun með JavaScript

JavaScript er nauðsynlegt forritunarmál til að búa til WordPress forrit. WordPress mótaði kóðunarreglur þannig að verktaki geti komið með samræmi á meðan þeir stíla JavaScript kóða. Fáir þessara kóðunarstaðla eru nefndir hér að neðan.

  • Refactoring frumkóði

Vegna ósamræmis í kóðauppbyggingu WordPress fyrir JavaScript var endurnýjun frumkóða mikilvæg til að halda þeim uppfærðum. WordPress er smám saman að leysa þetta mál. Það mælir með því að forritarar sem eru að vinna að JavaScript kóða fylgi núverandi nauðsynlegum leiðbeiningum. En fyrir eldri JavaScript skrár er endurstilling ekki nauðsynleg.

  • Notkun bils

WordPress mælir með því að nota bil á viðeigandi hátt til að auka læsileika frumkóðans þíns, sem gerir hann fínstilltan fyrir vafra til að vinna úr honum.

Kóðunarreglur styðja að flipa verði að nota til inndráttar. Fjarlægja verður hvítt bil á auðum línum og í lok lína. Sérhver kóðalína ætti ekki að vera lengri en 80 stafir. Nota verður axlabönd fyrir ef/fyrir/reyna kubba og ætti að slá inn á margar línur.

Niðurstaða

Markmið kóðunarstaðla er að hjálpa forriturum að mynda læsilegan kóða. Því hreinni sem kóðinn lítur út, því auðveldara er fyrir aðra að skilja og útfæra. WordPress er opinn hugbúnaður sem er studdur með framlagi vaxandi samfélags stuðningsmanna.

Svo, meðan þú býrð til WordPress verkefnið þitt, mundu að fylgja kóðunarreglugerðinni svo þú getir lagt til gæðakóðun.   

tengdar greinar

0 Comments
Inline endurgjöf
Skoða allar athugasemdir
Til baka efst á hnappinn