când vă alăturați unui nou proiect sau citiți un cod open source, trebuie să fi observat că unele proiecte sunt organizate uniform și bine structurate, în timp ce altele sunt dezordonate și încurcate? Dacă rezumăm factorii care produc un astfel de efect asupra bazei de cod, întâlnim noțiunea de convenție de cod.

să descoperim:

  • ce sunt convențiile de cod?
  • cum adoptarea lor poate duce la beneficii uriașe pentru proiectul dumneavoastră?
  • ce este SwiftLint?
  • și ce stiluri de cod Swift să alegeți?

definirea Convenției Codului Swift

Convenția codului este un set de dos și interdicții care descriu organizarea fișierelor, practicile de programare, modelele de proiectare, abordarea arhitecturală etc. Poate fi un set formal de reguli care este urmat de o echipă, organizație sau individ sau poate fi la fel de informal ca un obicei de a aplica anumite practici de codificare.

Code style este un subset de convenție de cod care guvernează formatarea fișierelor, cum ar fi indentarea, poziția virgulelor, bretele, capitalizarea etc. În comunitatea Swift, distincția dintre cele două nu se face de obicei și se folosește termenul comun Swift code style sau uneori Swift style guide.

Iată cum ar putea arăta convențiile de codificare:

  • denumirea fișierului: un fișier care conține un singur tip trebuie să aibă același nume ca și tipul.
  • limita lungimii liniei: o singură linie de cod nu trebuie să depășească 160 de caractere.
  • Denumire: variabilele sunt lowerCamelCase.

de ce să folosiți stilul Codului Swift

fiecare Dezvoltator Swift știe că limba are un potențial imens, care la rândul său poate aduce o mulțime de complexitate, poate face codul încurcat și greu de citit și de întreținut. Prin urmare, scopul principal al stilului Codului Swift este de a reduce această complexitate prin descrierea practicilor bune și rele de scriere a codului Swift.

de ce este atât de important să faci Codul mai ușor de citit?

potrivit lui Robert C. Martin, timpul petrecut citind codul este de peste 10 ori mai mult decât scrierea acestuia. În plus, citim în mod constant codul existent pentru a scrie unul nou.

o altă cercetare din fapte și erori ale ingineriei Software afirmă că 40% -80% din costul total al programului merge la întreținere.

să rezumăm beneficiile pe care le oferă ghidul de stil Swift:

  • ajută la înțelegerea structurii proiectului.
  • îmbunătățește lizibilitatea codului.
  • facilitează întreținerea.
  • accelerează îmbarcarea pentru noii membri ai echipei.
  • oferă posibilitatea de a stăpâni cele mai bune practici de programare.
  • devine un instrument de comunicare între programatorii din comunitate.

datorită unui impact atât de mare, convențiile de codificare sunt de obicei adoptate de organizațiile IT și chiar de comunități întregi de programare.

proiectarea unui stil de cod de la zero este o sarcină non-banală și necesită eforturi consolidate. Din fericire, ca Dezvoltatori Swift, nu trebuie să reinventăm roata și Putem utiliza mai multe ghiduri de stil Swift existente.

să explorăm mai detaliat cele mai proeminente stiluri de codificare Swift.

explorarea stilurilor de cod Swift

definiția stilului de cod bun este subiectivă, iar recomandarea mea personală este să elaborez mai multe stiluri și să le modelez în funcție de nevoile proiectului dvs. Lista de mai jos este aici pentru a vă ajuta.

1. Swift.org

acest ghid este un standard implicit în comunitatea Swift. Acesta consolidează setul minim absolut de reguli pe care fiecare Dezvoltator Swift trebuie să le înțeleagă și să le urmeze.

ghidul se concentrează pe aspectele fundamentale ale designului API Swift, care este urmat de toate cadrele de sistem. Nu numai că va face codul dvs. să arate organic împreună cu API-urile de sistem, dar va facilita și citirea și înțelegerea cadrelor de cacao.

pe cont propriu, Swift.org stilul de cod nu este suficient pentru a oferi un set cuprinzător de reguli, dar face un mare plus față de celelalte ghiduri enumerate mai jos.

legătură: Swift.org Cod stil

2. Google

nu întâlniți în mod normal ‘Google’ și ‘Swift’ într-o singură propoziție, dar nu de data aceasta. Google înțelege, fără îndoială, importanța convențiilor de cod și creează convenții pentru fiecare proiect major open-source, așa cum se menționează în ghidurile de stil Google. Cred că ar trebui să mulțumim TensorFlow pentru acest ghid Swift.

acest stil de cod Swift impresionează prin exhaustivitatea sa. Acesta acoperă atât de multe aspect care pur și simplu listarea lor aici ar face acest articol de două ori mai mult timp.

ceea ce este cu adevărat valoros în acest ghid este că fiecare punct este bine întemeiat prin enumerarea bunelor practici de programare care sunt adesea fundamentale pentru toate limbile. Secțiunea de practici de programare, pe care vă recomand să o citiți dacă sunteți în căutarea unui ghid Swift sau nu, strălucește cu adevărat în acest aspect.

după ce ați citit și înțeles acest ghid, vă veți găsi un programator mai bun în general, precum și adăugați o grămadă de trucuri rapide în buzunar.

Link: Google Swift Cod stil

3. Ray Wenderlich

echipa din spatele raywenderlich.com este bine cunoscut în comunitatea iOS și nu are nevoie de o introducere specială. La fel ca și articolele lui Ray, Ghidul este scris într-o manieră clară și ușor de înțeles și este potrivit în special pentru noii veniți rapizi

acest ghid atinge, fără îndoială, obiectivele declarate de a fi clar, consecvent și scurt. Fiecare regulă este urmată de o explicație completă, raționament și un set de exemple cu dos și interdicții.

ceea ce îmi place la acest ghid este că depășește sintaxa Swift și formatarea codului și explică bune practici de programare, cum ar fi evitarea codului neutilizat, explică diferența dintre tipurile de valoare și referință, conceptele de inițializare leneșă, controlul accesului, returnări timpurii și multe altele.

în momentul în care scriu acest articol, acesta are deja 137 de cereri de tragere închise, ceea ce demonstrează că ghidul este puternic susținut de comunitate.

legătură: Ray Wenderlich Swift Cod stil

4. LinkedIn

LinkedIn face o treabă excelentă în aprovizionarea deschisă a componentelor lor interne, iar cele Swift nu fac excepție. Ghidul lor de stil Swift a existat de peste 3 ani și a încorporat o mulțime de îmbunătățiri atât din partea comunității open source, cât și a echipei LinkedIn.

Ghidul LinkedIn Swift este scurt, concis și bine structurat. Explicații teoretice scurte sunt adesea furnizate pentru a înțelege mai bine raționamentul din spatele anumitor reguli. Exemplele sunt întotdeauna auto-explicative și demonstrează clar punctul.

ghidul se concentrează în principal pe formatarea codului și vă recomand să îl utilizați în combinație cu alte stiluri de cod Swift din această listă.

Link: LinkedIn Swift Cod stil

5. Airbnb

echipa Airbnb este binecunoscută pentru contribuția lor valoroasă la comunitatea iOS. În momentul în care scriu acest articol, Airbnb Swift Style Guide are doar 1 săptămână, ceea ce îl face cel mai proaspăt din această listă.

de la bun început, ghidul stabilește contextul potrivit explicând de ce aveți nevoie de un stil de cod și sunt complet de acord cu fiecare punct.

Ghidul este o plăcere de citit: este bine structurat și regulile sunt explicate cu precizie. În cazul în care are sens, fiecare punct este însoțit de exemple de dos și dont și context teoretic. Aproape fiecare regulă se face lintable cu SwiftLint – un instrument analizor static care vor fi discutate câteva paragrafe de mai jos.

îmi place mai ales secțiunea de modele în care Airbnb oferă sfaturi rapide practice pe care le recomand să le verificați. De exemplu, se prescrie pentru a utiliza valori imuabile în loc de mutabile și oferă sfaturi cu privire la definirea enums. Preferatul meu este tratarea condițiilor neașteptate în care utilizarea afirmațiilor, precondițiilor și erorilor fatale este explicată în detaliu.

Ghidul oferă chiar și setările editorului Xcode pentru a satisface Regulile din secțiunea de formatare care pot fi aplicate cu ușurință prin intermediul unui script.

Link: Airbnb Swift Style Guide

Swift code Linter SwiftLint

suntem cu toții oameni și în mod deliberat sau nu, cu toții facem greșeli. Astfel, nu este suficient să se documenteze sau să se convină verbal asupra convențiilor de codificare Swift. Pentru a minimiza numărul de greșeli, Regulile trebuie aplicate de un instrument automat, cunoscut sub numele de linter.

Linter este un analizor de cod static care găsește erori de programare, bug-uri, erori de formatare și construcții potențial dăunătoare.

SwiftLint este cel mai utilizat analizor de cod Swift care poate fi configurat pe baza regulilor personalizate. Dacă nu îl utilizați deja, vă recomand să verificați SwiftLint și să începeți să îl utilizați în proiectele Swift cât mai curând posibil.

cel mai important lucru de înțeles despre SwiftLint este că nu impune un ‘stil unic adevărat’, ci ajută la consecvența în cadrul unui proiect.

rezumat

convențiile de cod Uniform contribuie foarte mult la programarea productivității și dorim întotdeauna să fim cât mai productivi posibil.

lista cu cele mai notabile stiluri de codificare Swift este o sursă excelentă de cele mai bune practici Swift și un punct de plecare pentru a elabora propriul set de convenții.

stilul bun al Codului Swift este subiectiv și ar trebui lăsat în seama dvs. și a echipei dvs. Odată ce este aprobat și documentat, un astfel de stil devine un standard și trebuie să fie consecvent în cadrul proiectului pentru a îmbunătăți lizibilitatea, ceea ce duce la numeroase beneficii.

SwiftLint este un instrument adoptat pe scară largă în comunitatea Swift, care ajută la aplicarea convențiilor de codificare. Ajută la evitarea greșelilor umane din timp și poate fi o adăugare valoroasă la stiva de instrumente a proiectului dvs.

Lasă un răspuns

Adresa ta de email nu va fi publicată.