WordPress

Atidžiau pažvelkite į „WordPress“ kodavimo standartus

„W3tech“ duomenimis, 65.1% svetainių, kuriose naudojama turinio valdymo sistema, veikia „WordPress“. Tai garsi atvirojo kodo TVS, parašyta PHP kalba. Dėl daugybės pasirinktinių temų ir papildinių daugelis SaaS teikėjų ir skaitmeninės rinkodaros agentūrų naudoja „WordPress“ svetainėms kurti.

Kodėl „WordPress“ pristatė kodavimo standartus?

Kadangi „WordPress“ yra didžiulė atvirojo kodo programinė įranga, ją sudaro didžiulis šaltinio kodas, kurį reikia paleisti. Taip yra dėl kelių kūrėjų indėlio iki šios datos. Kadangi kodavimą galima atlikti keliais stiliais, kūrėjai prie „WordPress“ platformos gali pridėti bet kokį jiems žinomą kodą. Tai gali sukelti „WordPress“ komplikacijų.

Jei „WordPress“ šaltinio kode būtų įdiegti keli kodavimo stiliai, skirtingiems programinės įrangos kūrėjams būtų sudėtinga skaityti ir išplėsti programinės įrangos programas. „DevOps“ darbuotojams, nuskaitantiems skirtingų stilių kodą, būtų sunku nustatyti klaidas. Dėl to paleidimo metu svetainės gali sugesti, o įmonės gali prarasti klientų.

Siekdama užkirsti kelią tokioms aplinkybėms, „WordPress“ pristatė kodavimo standartus. Tai buvo taisyklių rinkinys, kurio kūrėjai privalo laikytis plečiant „WordPress“ funkcionalumą.

Kodavimo standartai supaprastina kodų pavyzdžių tvarkymo ir įvertinimo procesą. Taip yra todėl, kad jie laikosi tų pačių formatavimo stilių, todėl skirtingiems kūrėjams lengviau suprasti, kas vyksta šaltinio kode. Apskritai kodavimo standartai padeda išlaikyti kitų kūrėjų sukurtų šaltinio kodų kokybę.

Kokius kodavimo standartus naudoja „WordPress“?

„WordPress“ priklauso ne tik nuo PHP kalbos. Jis taip pat naudoja HTML, CSS ir JavaScript. Taigi, jo kodavimo standartai skiriasi priklausomai nuo šių programavimo kalbų. Jei nekantraujate sukurti savo „WordPress“ papildinį ir patobulinti „WordPress“ platformą, čia yra kodavimo standartai, kurių turite laikytis kurdami kodą.

1. Kodavimas su PHP

Siekdama užtikrinti vienodą, švarų ir suprantamą kodavimą, „WordPress“ pristatė PHP žymėjimo kodavimo standartus. Jei kuriate bet kokius „WordPress“ projektus naudodami PHP žymėjimą, laikykitės šių kodavimo taisyklių.

  • Citatos naudojimas

„WordPress“ rekomenduoja tinkamomis sąlygomis naudoti dvigubas ir viengubas kabutes. Kai niekas neįvertinamas, eilutėje galima naudoti pavienes kabutes. Kai naudojate kabutes, vieną kabučių stilių pasilikite naudoti eilutėje, o kitą – visai eilutei.

Nerekomenduojama palikti kabučių eilutėje.

  • Įspaudas

Naudodama įtraukas, „WordPress“ pabrėžia, kad naudoja tabuliavimo klavišus, o ne tarpo klavišus, kad žymėtų įtraukas kodo eilutes. To pranašumas yra tas, kad jūsų kodas tampa suderinamas su skirtingais redaktoriais, kurie jį naudoja skirtingose ​​platformose.

Įtrauka padeda loginėms kodo sritims išsiskirti, todėl jos tampa aiškios ir suprantamos

Jei naudojate asociatyvinius masyvus ir jame yra keli elementai, kiekvienas to masyvo elementas turi turėti savo naują eilutę. Paskutinio masyvo elemento pabaigoje pridėkite kablelį. Tai palengvina naujų elementų įtraukimą į masyvą arba jo tvarkos keitimą.

  • PHP žymės

Naudojant PHP kodo fragmentus HTML blokuose, PHP atidarymo ir uždarymo žymos turi būti atskiroje eilutėje.

„WordPress“ draudžia naudoti sutrumpintas PHP žymas, nes jos gali sukelti problemų vykdant kodą.

  • Petnešos

„WordPress“ įpareigoja kode naudoti skliaustus. Pradžios teiginio eilutėje turi būti įterptas skliaustas. Skliaustai praleidžiami tik vienos eilutės sakiniuose. Ciklo sakiniuose taip pat turi būti petnešos. Jei naudojami kelių blokų teiginiai, skliaustai yra būtini.

  • Erdvės naudojimas

Tarpas turi būti pateiktas abiejose priskyrimo, loginių, palyginimo ir eilučių operatorių pusėse ir po kablelių. Tarpas taip pat turi būti po atidarymo ir prieš uždarant skliaustus, išskyrus šriftus. Kiekvienos kodo eilutės pabaigoje esantys tarpai turi būti ištrinti.

  • SQL sakiniai

„WordPress“ kodavimo standartai skatina SQL teiginius rašyti didžiosiomis raidėmis. Šiuos teiginius galima parašyti vienoje eilutėje, jei jie yra trumpi ir lengvai skaitomi. Sudėtingoms SQL užklausoms patariama jas padalyti į kelias eilutes, įtraukiant kiekvieną SQL sakinį.

  • Pavadinimo principai

Kūrėjai, pavadindami funkcijas, klases ir failus, privalo laikytis „WordPress“ taisyklių, kad išvengtų nepatogių klaidų. Kuriant funkcijas ar kintamuosius pavadinimai turi būti rašomi mažosiomis raidėmis, o camelCase griežtai draudžiama. Jei pavadindami naudojami keli žodžiai, atskirkite juos pabraukimu.

Panašiai yra ir failų pavadinimų atveju, išskyrus tai, kad jei naudojami keli žodžiai, jie turi būti atskirti brūkšneliu. Jei failą sudaro klasė, failo pavadinimas turi būti parašytas formatu klasės–klasės pavadinimas mažosiomis raidėmis, kiekvieną apatinį brūkšnį pakeičiant brūkšneliu.

Jei failai, sudaryti iš šablonų žymų, yra skaitomi arba pridedami aplanke wp-includes, prie to failo pavadinimo turi būti pridėtas -šablonas.

Kuriant klases, klasių pavadinimai turi būti rašomi didžiosiomis raidėmis. Jei naudojami keli žodžiai, jie turi būti atskirti pabraukimu ir kiekvienas žodis turi būti rašomas didžiosiomis raidėmis.

2. Kodavimas su HTML

Kodavimo taisyklėse teigiama, kad prieš rankinį kodo patikrinimą HTML kodo fragmentai turi būti paleisti per W3C tikrintuvą. Tai padeda aptikti ir ištaisyti visas kodo žymėjimo klaidas. Pridedant HTML kodavimą, reikia laikytis šių standartų.

  • Savaime užsidarančios žymos

Su savaime užsidarančiomis žymomis HTML reikia elgtis atsargiai, ypač su tarpais. W3C nurodo, kad tarpas turi būti prieš savaime užsidarantį pasvirąjį brūkšnį, kai naudojamos savaime užsidarančios žymos.

  • Žymos ir atributai

Žymos padeda sukurti HTML puslapio struktūrą. Jie supa žiniatinklį ir leidžia naršyklei nustatyti, koks tai turinys. Atributai suteikia papildomos informacijos apie HTML elementus.

„WordPress“ kodavimo taisyklėse nurodoma, kad visos HTML žymos ir atributai turi būti rašomi mažosiomis raidėmis. Atributų reikšmės taip pat turi būti parašytos mažosiomis raidėmis, kad būtų galima interpretuoti mašiną. Kad duomenys būtų suprantami žmonėms, galima naudoti tinkamą didžiųjų raidžių rašymą.

  • Citatos

Rašant atributų reikšmes XHTML, būtina naudoti dvigubas arba viengubas kabutes. „WordPress“ HTML kodavimo standartai rekomenduoja tą patį formatą, kad būtų išvengta HTML kodo saugos problemų.

3. Kodavimas su CSS

CSS yra dar viena svarbi programavimo kalba kuriant jūsų tinklalapių išdėstymą ir temą. „WordPress“ pristatė CSS kodavimo kodavimo standartus, kad kūrėjai galėtų sukurti nuoseklų, švarų ir skaitomą kodą projektams. Čia yra rekomenduojamos gairės.

  • struktūra

 CSS suteikia daug galimybių kurti stiliaus lapą. Tačiau „WordPress“ pateikia pagrindines CSS gaires, kaip sukurti aiškų ir atskirą kodą. Tai padeda kitiems kūrėjams bendradarbiauti su jumis, kad suprastų jūsų dokumento eigą.

Gairėse patariama naudoti skirtukus kiekvienai kode naudojamai nuosavybei įtraukti. Kodavimo blokuose, priklausančiuose tai pačiai daliai, tarp kiekvieno bloko turi būti viena tuščia eilutė. Norint atskirti kodavimo dalis, tarp kiekvienos kodavimo dalies reikia pridėti 2 tuščias eilutes.

Jei pateikiate kelis vieno taisyklių rinkinio parinkiklius, kiekvienas parinkiklis turi būti parašytas atskiroje eilutėje. Ypatybės ir vertės poroms kiekviena turi turėti savo eilutę, naudoti vieną įtraukos skirtuką ir baigtis kabliataškiu. Naudojant tik vieną selektorių, toje selektorių eilutėje turi būti įdėta atidarymo svirtis.

Kitu atveju atidarymo svirtis turi būti įtraukta į paskutinę parinkiklio eilutę, o uždarymo svirtis turi būti dedama į atskirą eilutę toje pačioje įtraukoje kaip ir atidarymo parinkiklis.

  • Selektoriai

Selektorių kodavimo standartas yra panašus į PHP failų pavadinimų kodavimo standartus. Vardinant parinkiklius, jie turi būti rašomi mažosiomis raidėmis, o atskiriant kelis žodžius turi būti naudojami brūkšneliai. Draudžiama naudoti CamelCase ir apatinius brūkšnius.

Rinkėjų pavadinimai turėtų trumpai apibūdinti, kokius elementus jie stilizuoja. Šie pavadinimai turėtų būti suprantami žmonėms. Atributų parinkikliuose aplink jų reikšmes reikia dėti dvigubas kabutes.

  • Skelbimų

„WordPress“ neskatina naudoti konkrečių savybių, dėl kurių gali sumažėti dizaino lankstumas. Jo kodavimo standartas pataria, kad po kiekvienos savybės turi būti dvitaškis ir tarpas.

Savybės ir reikšmės turi būti rašomos mažosiomis raidėmis, išskyrus šriftų pavadinimus. Norėdami pridėti spalvų, pirmenybė teikiama šešioliktainiams kodams arba rgba() ir turi būti naudojamos mažosios raidės. Patartina naudoti trumpąsias ypatybes fono, kraštinės, šrifto, sąrašo stiliaus, paraštės ir užpildymo reikšmėms.

4. Kodavimas su JavaScript

„JavaScript“ yra būtina programavimo kalba kuriant „WordPress“ programas. „WordPress“ suformulavo kodavimo taisykles, kad kūrėjai galėtų užtikrinti nuoseklumą kurdami „JavaScript“ kodą. Kai kurie iš šių kodavimo standartų yra paminėti toliau.

  • Perdirbimo šaltinio kodas

Dėl neatitikimų „WordPress“ kodo struktūroje, skirtoje „JavaScript“, šaltinio kodų pertvarkymas buvo svarbus norint jį atnaujinti. „WordPress“ palaipsniui sprendžia šią problemą. Ji rekomenduoja kūrėjams, kurie dirba su „JavaScript“ kodu, vadovautis dabartinėmis būtinomis gairėmis. Tuo tarpu senesniems „JavaScript“ failams perdaryti nereikia.

  • Tarpų naudojimas

„WordPress“ rekomenduoja tinkamai naudoti tarpus, kad pagerintumėte šaltinio kodo skaitomumą ir optimizuotų jį naršyklėms apdoroti.

Kodavimo taisyklės patvirtina, kad skirtukas turi būti naudojamas įtraukai. Tuščiose eilutėse ir eilučių pabaigoje turi būti pašalintas tarpas. Kiekviena kodo eilutė neturi viršyti 80 simbolių. Skliaustai turi būti naudojami jei/for/try blokams ir turi būti įvesti keliose eilutėse.

išvada

Kodavimo standartų tikslas – padėti kūrėjams suformuoti įskaitomą kodą. Kuo švaresnis kodas atrodo, tuo lengviau jį suprasti ir įgyvendinti kitiems. „WordPress“ yra atvirojo kodo programa, kurią palaiko auganti rėmėjų bendruomenė.

Taigi kurdami „WordPress“ projektą nepamirškite laikytis kodavimo taisyklių, kad galėtumėte prisidėti prie kokybiško kodavimo.   

Susiję straipsniai

0 komentarai
Inline atsiliepimai
Peržiūrėti visus komentarus
Atgal į viršų mygtukas