curat
„Codul meu funcționează bine, site-ul pe care l-am construit arată foarte bine și clientul meu este fericit. Deci, de ce mi-ar păsa în continuare să scriu cod curat? ”

Dacă sună ca tine, atunci citește mai departe.

Cu puțin timp în urmă, am avut o discuție cu unul dintre prietenii mei, Kabir. Kabir este un programator cu experiență. Lucra la un proiect complex și discuta cu mine o problemă. Când am cerut să văd codul pentru această problemă, el a spus, sunând mândru: „Am construit acest proiect, astfel încât să fim singurii care pot înțelege codul”.

Eram destul de îngrozit. L-am întrebat dacă a scris în mod deliberat cod murdar.

„Clientul nu mi-a acordat suficient timp”, mi-a spus prietenul meu. "El se grăbește mereu și face presiuni pentru livrări, așa că nu am avut timp să mă gândesc la curățarea acesteia".

Aceasta este aproape întotdeauna scuza pe care o aud când întreb despre codul murdar.

Unii programatori scriu cod murdar, deoarece intenționează să lanseze prima versiune de lucru și apoi să lucreze pentru a o curăța. Dar nu funcționează; niciun client nu vă oferă timp pentru a curăța codul. Odată lansată prima versiune, ei vă vor împinge pentru a doua. Deci, faceți-vă obișnuit să scrieți cod cât mai curat posibil de la prima linie de cod.

Am învățat întotdeauna că utilizarea principiilor codului curat are multe avantaje și această postare vă va arăta de ce.

Sarcina managerului de proiect, a șefului de vânzări sau a clientului este de a realiza proiectul în timp minim, astfel încât să poată controla costul proiectului. Dar producerea unui cod curat și de calitate este datoria ta ca programator.

Scrierea unui cod curat nu este o sarcină importantă sau care necesită mult timp, dar transformarea în rutină și angajarea în acest sens vor contribui mult la dezvoltarea carierei și îmbunătățirea propriului management al timpului.

Codul curat pare întotdeauna că a fost scris de cineva căruia îi pasă.

„Orice prost poate scrie cod pe care un computer îl poate înțelege. Programatorii buni scriu cod pe care oamenii îl pot înțelege. ”- Martin Fowler

Probabil că ați citit până aici din două motive: În primul rând, sunteți programator. În al doilea rând, vrei să fii un programator mai bun. Bun. Avem nevoie de programatori mai buni.

Continuați să citiți pentru a afla de ce contează codul curat și veți deveni un programator mai bun.

De ce ar trebui să ne străduim pentru un cod curat?

Codul curat este ușor de citit și ușor de înțeles de către toți dacă cititorul este autorul codului sau un nou programator.

Scrierea unui cod curat este o mentalitate necesară. Este nevoie de practică pentru a scrie un cod curat și structurat și veți învăța să o faceți în timp. Dar trebuie să începeți cu mentalitatea de a scrie în acest fel. Și te vei obișnui cu revizuirea și revizuirea codului tău, astfel încât să fie cât mai curat.

Nimeni nu este perfect și deci nici tu nu ești. Veți găsi întotdeauna unele oportunități de a îmbunătăți sau refactura codul atunci când reveniți pentru a vă examina codul după câteva zile sau săptămâni. Deci, începeți să scrieți codul cât mai curat posibil din prima linie de cod, astfel încât mai târziu să puteți lucra mai mult la îmbunătățirea performanței și logicii.

Avantajele Clean Code

„De ce ar trebui să îmi pese să scriu cod curat?” s-ar putea să te întrebi în continuare.

Există multe motive pentru a intra în mentalitatea cu codul curat pe care am descris-o mai sus. Unele dintre cele mai importante motive sunt:

O mai bună utilizare a timpului tău

Primul beneficiar al codului curat este programatorul în sine. Dacă lucrați la un proiect de luni de zile, este ușor să uitați lucrurile pe care le-ați făcut în cod, mai ales atunci când clientul dvs. revine cu modificări. Liniile de cod curate facilitează modificările.

Integrare mai ușoară pentru membrii noii echipe

Utilizarea principiilor codului curat ajută la integrarea unui nou programator. Nu este nevoie de documentație pentru a înțelege codul; noul programator poate sări direct în el. Aceasta economisește, de asemenea, timp atât pentru antrenarea noului programator, cât și timpul necesar pentru ca noul programator să se adapteze la proiect.

Depanare mai ușoară

Fie că scrieți cod murdar sau curat, erorile sunt inevitabile. Dar codul curat vă va ajuta să depanați mai repede, indiferent de cât de multă experiență sau expertiză aveți.

Și nu este neobișnuit ca colegii sau managerii să vă ajute să rezolvați problema. Dacă ați scris cod curat, nicio problemă: aceștia pot să intre și să vă ajute. Dar dacă managerul tău trebuie să treacă prin codul tău murdar, ei bine, ai putea ajunge ca prietenul meu Kabir.

Întreținere mai eficientă

„Desigur, codul rău poate fi curățat. Dar este foarte scump. "
C.Robert C. Martin

Întreținerea nu se referă la remedierea erorilor. Pe măsură ce orice proiect crește, va avea nevoie de funcții noi sau modificări ale caracteristicilor existente.

Știți că costul major al unui proiect software este în întreținere? Compania va lansa întotdeauna prima versiune sau produsul minim viabil (MVP) cât mai curând posibil. Funcțiile suplimentare sau noi sunt întotdeauna o idee ulterioară, pe măsură ce software-ul folosește mai mult. Codul curat face ca întreținerea să fie relativ rapidă și ușoară.

Aceste prime trei puncte explică modul în care codul curat poate economisi timpul unui programator. Și, economisind puțin timp în fiecare zi va avea un efect compus asupra timpului de livrare și a costului software-ului. Este bine pentru compania dvs.

Te vei simți bine

Vă ajută să vă simțiți încrezători să vă împărtășiți și munca cu alții? Sau cu clientul dumneavoastră?
Dacă scrieți un cod curat și de calitate, ar trebui să vă simțiți foarte încrezători. Nu ar trebui să vă fie frică de avarie; puteți remedia defectele mai repede.

Și asta înseamnă că, probabil, vă bucurați și de programare.

Acum, cum scrieți un cod curat?

Cum se scrie un cod curat

"Ar trebui să denumiți o variabilă folosind aceeași grijă cu care numiți un copil întâi născut."
C. Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship

Un programator este autor, dar s-ar putea să facă greșeala în identificarea publicului. Publicul unui programator este alți programatori, nu computere. Dacă computerele ar fi publicul, atunci s-ar putea să scrieți codul în limbajul mașinii.

Deci, pentru a fi ușor de înțeles pentru publicul dvs., ar trebui să utilizați o nomenclatură semnificativă pentru variabile, funcții și clase. Și faceți-o mai ușor de citit folosind indentare, metodă scurtă și enunț scurt, acolo unde este cazul:

De asemenea, ar trebui să limitați o funcție sau o metodă la o singură sarcină. (Evitați să folosiți „și” într-un nume de metodă, cum ar fi „validați și salvați”. În schimb, creați două metode, una pentru validare și alta pentru salvare).

Indentarea este, de asemenea, importantă. Codul dvs. curat trebuie să utilizeze patru spații pentru liniuțe, nu tasta tab. Dacă aveți deja obiceiul de a utiliza tasta tab, modificați setarea IDE pentru ca tasta tab să denote patru spații, spre deosebire de cele cinci obișnuite.

Dacă metoda dvs. are mai mult de trei indentări, atunci este timpul să refacturați noi metode.

  • Comportamentul clasei și al obiectului. O clasă ar trebui să facă un lucru. Dacă este pentru utilizator, atunci toate metodele trebuie scrise în întregime pentru experiența utilizatorului.
  • Nu comentați coduri greșite. Dacă trebuie să adăugați comentarii pentru a explica codul, înseamnă că trebuie să vă refactorizați codul și să creați noi metode. Comentează numai dacă este obligatoriu din punct de vedere legal sau dacă trebuie să păstrezi note despre viitorul sau istoricul programului.
Exemplu de cod murdar Exemplu de cod curat
// Verificați dacă angajatul este eligibil pentru beneficii complete
if ($ angajat-> steaguri && auto: HOURLY_FLAG && $ angajat-> vârsta> 65)		if ($ angajat-> isEligibleForFullBenefits ())
  • Utilizați Git pentru istoricul versiunilor. Uneori, schimbarea caracteristicilor și metodele trebuie rescrise. De obicei, comentăm vechiul cod de teamă că clienții vor face o întoarcere și vor solicita versiunea mai veche. Dar dacă utilizați sistemul de control al versiunilor Git, acesta va păstra toate versiunile stocate, deci nu este nevoie să păstrați codul mort. Scoateți-l și faceți codul curat.
  • Evitați să lucrați cu o gamă mare. Evitați să creați o matrice pentru un set mare de date; în schimb, utilizați o clasă. Acest lucru îl face mai ușor de citit, fără a menționa că creează o siguranță suplimentară pentru aplicația dvs.
  • Nu repetați codul. De fiecare dată când scrieți o metodă, întrebați-vă dacă a fost deja construit ceva similar. Verificați biblioteca de coduri sau altă documentație.
  • Nu faceți hardcode. Definiți constantă sau utilizați variabile în loc să codificați valorile. Utilizarea variabilei nu numai că o va face lizibilă, ci va facilita și schimbarea dacă este utilizată în mai multe locuri.
Exemplu de cod murdar Exemplu de cod curat
if (7 == $ azi) returnează „Este vacanță”;
>		const SÂMBĂTĂ = 7;
if (self: SATURDAY == $ today) returnează „Este vacanță”;
>

Câteva alte sfaturi pentru un cod mai curat

Examinați-vă singur codul. Examinați codul dvs. din când în când. Sunt sigur că veți găsi ceva nou de îmbunătățit de fiecare dată când îl revizitați.

Examinați codul împreună cu colegii. Examinați codurile colegilor dvs. și cereți-le să le examineze pe ale dvs. Nu ezitați să luați în considerare sugestii.

Fiecare limbă are propria convenție de denumire. Dacă scrieți pentru PHP, utilizați ghidul de stil de codare al PSR-2.

Pentru a crește calitatea codului, ar trebui să utilizați abordarea TDD și să scrieți teste unitare. Dezvoltarea bazată pe test facilitează modificările de cod; nu trebuie să vă temeți de defalcarea codului. Dacă ați făcut greșeli, testul unitar va eșua și veți ști ce caz de testare a eșuat și ce bloc de cod a fost responsabil pentru asta.

Utilizați sistemul de control al versiunii Git pentru a colabora la dezvoltare. Git devine un instrument esențial atunci când mai mulți programatori lucrează la un proiect. Revizuirea codului devine ușoară dacă utilizați un sistem de control al versiunilor.

Trecând la Codul mai curat

Scrierea unui cod curat are multe avantaje și este ușor de văzut de ce.

Cu aceste sfaturi, poți fi pe drumul cel bun pentru a scrie cod pe care toată lumea îl poate înțelege - și care îți va face viața mai ușoară pe termen lung.

Vă va ajuta și colegii, echipa și angajatorul.