Scrierea unui cod curat este ceea ce trebuie să știți și să faceți pentru a vă numi dezvoltator profesionist. Nu există o scuză rezonabilă pentru a face ceva mai puțin decât cel mai bun lucru pe care îl puteți face.

bune

În această postare de blog schoolofJavaScript.com, Vom acoperi principiile generale de codificare curată pentru denumirea și utilizarea variabilelor și funcțiilor, precum și unele dintre cele mai bune practici de codificare curată specifice JavaScript.

În primul rând, ce înseamnă codificare curată?

Codificarea curată înseamnă că el scrie mai întâi codul, astfel încât să poată revizui ulterior el însuși și pentru colegii săi, și nu pentru mașină.

Știți că lucrați la un cod curat atunci când fiecare rutină pe care o citiți se dovedește a fi aproape ceea ce vă așteptați.

Cele mai bune practici pentru codul JavaScript curat

Acum, că știm la ce ar trebui să aspire fiecare dezvoltator, să explorăm cele mai bune practici!

Cum ar trebui să-mi denumesc variabilele?

Folosiți nume care dezvăluie intenții și nu vă faceți griji dacă aveți nume variabile lungi în loc să salvați câteva apăsări de tastă.

Dacă urmați această practică, numele dvs. pot fi căutate, ceea ce ajută foarte mult atunci când faceți refactori sau doar căutați ceva.

De asemenea, faceți distincții semnificative și nu adăugați nume suplimentare și inutile la numele variabilelor, cum ar fi tipul lor (notația maghiară).


Faceți numele lor variabile ușor de pronunțat, deoarece este nevoie de mai puțin efort pentru ca mintea umană să le proceseze.

Când faceți recenzii de coduri cu colegii dvs. de dezvoltatori, aceste nume sunt mai ușor de referit.

Pe scurt, nu provocați o mapare mentală suplimentară cu numele dvs.

Cum ar trebui să-mi scriu funcțiile?

Funcțiile dvs. ar trebui să facă un singur lucru doar la nivel de abstractizare.


După ce vă scrieți corect funcțiile, puteți testa cât de bine v-ați descurcat cu profilul CPU, ceea ce vă ajută să găsiți blocaje.

Folosiți nume lungi, descriptive

Un nume de funcție trebuie să fie un verb sau o frază verbală și trebuie să comunice intenția sa, precum și ordinea și intenția argumentelor.

Un nume lung, descriptiv, este mult mai bun decât un nume scurt, enigmatic sau un comentariu lung, descriptiv.

Evitați lista lungă de argumente

În schimb, folosește un parametru de obiect unic și cartografierea destructurării. De asemenea, facilitează mult manipularea parametrilor opționali.

Reduceți efectele secundare.

Utilizați caracteristici pure, fără efecte secundare, ori de câte ori puteți. Sunt foarte ușor de utilizat și testat.

Organizați-vă funcțiile într-un fișier conform regulii de downgrade
Funcțiile de nivel superior trebuie să fie la nivelurile superioare și inferioare de mai jos. Este natural să citiți codul sursă.

Consultare sau modificare

Funcțiile trebuie să facă ceva (să modifice) sau să răspundă la ceva (interogare), dar nu ambele.

Toată lumea îi place să scrie JavaScript diferit, ce să facă?
Deoarece JavaScript este dinamic și scris flexibil, este predispus în special la erori de programare.

Utilizați regulile de lucru ale companiei și stilul de formatare.

Cu cât regulile sunt mai stricte, cu atât se va face mai puțin efort pentru a indica formatul greșit în recenziile de cod. Ar trebui să acopere lucruri precum nume consistente, dimensiunea indentării, plasarea spațiului alb și chiar punct și virgula.
Pentru început, stilul standard JS este destul de bun, dar nu suficient de strict în opinia mea. Pot accepta majoritatea regulilor în stilul Airbnb .

Cum se scrie un cod asincron frumos?

Folosește promisiunile ori de câte ori poți.

Promisiunile sunt disponibile în mod nativ de la nodul 4. În loc să scrieți apeluri de apel imbricate, puteți avea apeluri promisibile viabile.

Majoritatea bibliotecilor au interfețe de apel și promit, preferându-le pe acestea din urmă. Puteți chiar să convertiți API-urile de apel invers pentru a promite unul bazat, împachetându-le cu pachete precum es6-promisify .

Cum ar trebui să scriu cod performant?

În primul rând trebuie să scrieți un cod curat și apoi să folosiți profilul pentru a găsi blocaje de performanță.

Nu încercați niciodată să scrieți mai întâi performanță și cod inteligent, în loc să optimizați codul atunci când aveți nevoie de acesta și să faceți referire la impactul real în loc de micro-repere.

Cu toate acestea, există câteva scenarii simple, cum ar fi inițializarea cu nerăbdare a ceea ce puteți (de exemplu, schemele joi în handlerele de rute, care ar fi utilizate la fiecare cerere și ar adăuga cheltuieli generale dacă sunt recreate de fiecare dată) și utilizarea unui cod asincron în locul unui cod de blocare.