Sfaturi practice pentru îmbunătățirea codului

Pe acest site, petrecem o mulțime de informații de partajare a timpului și discutăm cum să realizăm anumite lucruri cu WordPress. La urma urmei, scopul site-ului este pentru a oferi tutoriale - adică, încercăm să oferim sfaturi practice despre cum să construim anumite lucruri folosind platforma.

Dar dezvoltarea nu se referă strict la scrierea de coduri și la construirea lucrurilor. De asemenea, este vorba de scrierea de coduri de calitate, de întreținut, de refacere și de îmbunătățirea stării proiectelor noastre și, în general, de a lăsa o bază de cod într-o stare mai bună decât atunci când am găsit-o (sau când am început să o creăm).

Deci, mai degrabă decât să se concentreze pe cum să construiască ceva sau să revizuiască orice cod special, să revizuiască câteva sfaturi practice pentru scrierea de calitate WordPress cod.


Codurile WordPress Coding

În primul rând și, deși discutăm foarte mult, merită repetat:

Urmărirea standardelor de codare WordPress este unul dintre cele mai importante lucruri pe care le puteți face atunci când scrieți teme, pluginuri sau aplicații.

Pentru cei care nu sunt familiarizați, standardele de codare WordPress oferă reguli pentru modul în care ar trebui să formăm PHP bazate pe WordPress. Desigur, nu există nimic de fapt impune regulile - le puteți ignora (și mulți fac), dar este considerat o bună practică pentru cei care sunt serios în a dezvolta proiecte bazate pe WordPress și este respectat de cei care sunt activi în comunitate.

În plus, conform standardelor de codificare înseamnă că noi, împreună cu toți ceilalți dezvoltatori care o realizăm, vor avea un cod asemănător. De fapt, unul dintre scopurile standardelor de codare definite este ca codul să pară ca acesta să fi fost scris de un singur dezvoltator.

Un alt avantaj pentru a face acest lucru este că, de asemenea, îi ușurează pe alții să contribuie la codul nostru. La urma urmei, deoarece WordPress și lucrările sale derivate sunt open source, alții ar putea dori să vină de-a lungul și furculite sau să contribuie în cele din urmă oferindu-le posibilitatea de a citi cu ușurință codul nostru.

În cele din urmă, aceasta nu este neapărat o chemare la acțiune pentru a vă întoarce și a refăge tot ce ați făcut fiecare. Acum e la fel de bun ca orice să înceapă respectarea standardelor. Dezvoltatorii buni se îmbunătățesc tot timpul, deci este total acceptabil să începeți acum (chiar dacă este în mijlocul unui proiect).

Comentarii cod

Unul dintre lucrurile cele mai utile pe care le puteți face atunci când scrieți codul este să lăsați comentarii utile care explică exact ceea ce încercați să faceți.

Firește, comentariile pot trăi la nivelul clasei, la nivel de funcție și la nivelul liniei. Sunt permise în PHP, HTML, JavaScript și CSS, astfel că nu există nicio scuză nu să le includem undeva.

Sigur, scrierea comentariilor durează un pic de timp suplimentar, dar rețineți că, dacă ar fi ușor de citit, nu se va numi cod.

Gândiți-vă în acest fel: Programatorii sunt notorii pentru revenirea la proiectele lor anterioare și recunoscând cât de rău este codul lor sau cum am face ceva diferit dacă lucrăm la acest proiect acum.

Dacă spunem despre codul nostru, ce trebuie să gândim ceilalți atunci când văd codul nostru mai ales dacă provin dintr-un mediu mai experimentat?

Pentru mai multe gânduri în profunzime cu privire la comentariul atât pentru server cât și pentru codul clientului, asigurați-vă că revizuiți această serie.


Funcții simplificate

Un alt lucru pe care dezvoltatorii îl putem face este simplificarea funcțiilor noastre. Deși îmi dau seama că aceasta este oarecum o zonă subiectivă, cred că scopul pentru funcții mai mici și mai concentrate face ca codul să fie mai ușor de citit și poate ajuta în cele din urmă cu testabilitatea (dacă sunteți interesat să mergeți pe acel traseu).

În primul rând, nu este deloc neobișnuit să vezi funcții care depășesc 30, 40 sau 50 de linii. Problema este că aceste funcții fac adesea mai multe lucruri.

Acest lucru este problematic deoarece:

  • Diagnosticarea problemei poate fi mai dificil de urmărit atunci când apare o eroare
  • Poate scădea lizibilitatea codului prin faptul că este mai dificil să se dea funcției un nume unic, descriptiv
  • Aceasta poate face dificilă scrierea unor teste unitare specifice deoarece funcțiile nu fac anumite lucruri.

Deci, cu toate acestea, există câteva sfaturi practice pe care le putem urmări pentru a îmbunătăți calitatea funcțiilor noastre.

Stai uscat

Dacă găsiți că scrieți același lucru mereu între diferite funcții, atunci este cazul când trebuie să extrageți acea parte a codului și să îl mutați în funcție, astfel încât acesta să poată fi apelat de toate locurile care există în prezent.

KISS Sus

Dacă găsiți că codul dvs. este fie complicat pentru a descrie cu comentarii sau dificil de urmărit în timp ce citiți prin el, atunci este posibil să meritați să faceți un pas înapoi și să vă refacționați codul în ceva mai simplu.

Acest lucru pare diferit în fiecare situație, dar încercarea de a fi lizibilă peste complexitate este de multe ori un obiectiv mai bun de a se strădui mai degrabă decât de a obține ceva simplu.

Intra in linie

Acesta este, fără îndoială, cel mai subiectiv punct, cred că merită să ne ridicăm și este pur și simplu că ar trebui să ne străduim să ne păstrăm funcțiile mici, cu lungimea de 20 de linii, fiind o lungime relativ solidă pentru care să ne îndreptăm. Sigur, acest lucru poate fi o provocare cu modul în care WordPress ne cere adesea să creăm matrice mari pentru a trece ca argumente, dar aveți ideea: păstrați-le mici, concentrate și întreținute.

Da, acest lucru va duce la mai multe funcții, dar codul va fi mai ușor de citit și de menținut deoarece fiecare funcție are un singur scop specific. Acest lucru înseamnă că le puteți numi cu o mai mare claritate și puteți oferi teste unitare în jurul lor mai ușor.


Concluzie

Evident, niciuna dintre cele de mai sus nu sunt reguli grele care trebuie urmate - sunt pur și simplu sugestii pentru îmbunătățirea calității codului pe care îl scriem, pe care îl susținem și pentru a contribui la munca altora.

Mai presus de toate, cred că ar trebui să ne străduim pentru lizibilitate și testabilitate. Menținerea acestor două scopuri reprezintă principala linie a muncii noastre, care va ajuta să conducem totul în locul potrivit.

Desigur, aceasta nu este o listă completă - este departe de ea! Așadar, vă rugăm să oferiți sugestiile dumneavoastră în comentarii!

Cod