Regulile „Cod curat” din Cartea 6 pentru denumirea optimă

Fabien, Dezvoltator web 28 august 2019

regulile

Cartea de dezvoltare Clean Code (sau Clean Code în versiunea sa originală) a fost scrisă de Robert C. Martin. Dezvoltator profesionist din 1970, a devenit și consultant internațional de software în 1990. Pentru a scrie această carte, autorul s-a înconjurat de o echipă de dezvoltatori experimentați pentru a împărtăși cele mai bune practici în cod.

Scopul cărții Clean Code este, prin urmare, să dobândească elementele de bază ale unui cod bun și să înțeleagă beneficiile pe care le oferă. Oferă cheile pentru a transforma codul rău în cod bun.

Acest articol este o primă recenzie a cărții lui Robert C. Martin. Revenim în principal la prima parte „The Naming”. Autorul oferă o definiție a ceea ce consideră că este un cod bun. Această parte tratează, de asemenea, dificultatea numirii obiectelor și variabilelor în dezvoltarea computerului.

Este important să vă luați timp pentru a codifica bine

Când „mai târziu” înseamnă „niciodată”

În Coder Proprement, autorul revine la„unul dintre principalele obstacole în calea unui cod bun: senzația de a rămâne fără timp. Cu toate acestea, codul neglijent este însăși sursa unei pierderi inevitabile de timp pe termen mai mult sau mai puțin lung.

De multe ori, când ne epuizăm timpul, credem că ne vom întoarce mai târziu pentru a curăța sau a elimina codul defect. Dar chiar crezi că vei găsi mai mult timp mai târziu ?

Dave LeBlanc își exprimă opinia în legea sa Leblanc: „Mai târziu nu înseamnă niciodată”(Din engleza Later Equals Never). Într-adevăr, amânarea se reduce adesea la a nu-și termina corect munca, prea ocupat cu noi misiuni. Prin urmare, este important să fiți organizat în mod optim pentru a dedica codului dvs. timpul pe care îl merită, la momentul potrivit.

Lăsați codul mai curat decât l-ați găsit

Un alt citat adaptează o regulă de băiat pentru a o transforma într-o regulă de cod bună: „Lăsați campingul mai curat decât l-ați găsit când ați ajuns”. DEVINE "Lăsați codul mai curat decât l-ați găsit.”

Într-adevăr, dacă fiecare face codul puțin mai curat decât cel recuperat, codul nu poate fi degradat. O curățare simplă poate fi uneori foarte utilă. Redenumirea unei variabile, divizarea unei funcții sau eliminarea unei redundanțe ușoare pot, de exemplu, îmbunătăți calitatea codului.

Denumirea corectă a elementelor de cod

Prima parte a cărții se referă la o problemă recurentă bine cunoscută dezvoltatorilor: denumirea variabilelor, claselor, funcțiilor etc. Cu toate acestea, fiecare dezvoltator are propria definiție a codului bun. Uneori este dificil să găsești adevărul absolut despre ceea ce este Codul bun.

Autorul se bazează aici pe experiența sa de a-și transmite propria viziune asupra bunelor practici, în special în ceea ce privește denumirea.

Iată o listă cu 6 reguli propuse în carte pentru o denumire optimă.

1. Descoperă-ți intențiile în nume

Potrivit lui Robert C. Martin, prima regulă de bază în denumire este utilizarea unui nume care dezvăluie intenții. Acest nume ar trebui să informeze despre scopul, misiunea și utilizarea acestuia.