når du blir med i et nytt prosjekt eller leser en åpen kildekode, må du ha lagt merke til at noen prosjekter er jevnt organisert og godt strukturert, mens andre er rotete og sammenflettet? Hvis vi oppsummerer faktorene som gir en slik effekt over kodebasen, kommer vi over begrepet kodekonvensjon.

La oss oppdage:

  • Hva er kodekonvensjoner?
  • Hvordan deres adopsjon kan resultere i store fordeler for prosjektet?
  • Hva Er SwiftLint?
  • og Hvilke Swift-kodestiler skal du velge?

Definere Swift Kode Konvensjonen

Kode konvensjonen er et sett av dos and don ‘ ts som beskriver filer organisasjon, programmering praksis, designmønstre, arkitektonisk tilnærming, etc. Det kan være et formelt sett med regler som følges av et lag, en organisasjon eller en person, eller være like uformelt som en vane med å anvende visse kodingspraksis.

Kodestil er et delsett av kodekonvensjon som styrer filformatering, for eksempel innrykk, plassering av komma, klammeparenteser, store og små bokstaver osv. I Swift samfunnet skillet mellom de to er vanligvis ikke gjort og fellesbetegnelsen Swift kode stil eller Noen Ganger Swift style guide brukes.

her er hvordan kodingskonvensjoner kan se ut:

  • filnavngivning: en fil som inneholder en enkelt type, må ha samme navn som typen.
  • linjelengdegrense: en enkelt linje med kode bør ikke overstige 160 tegn.
  • Navngivning: variabler er lowerCamelCase.

Hvorfor Bruke Swift-Kodestil

Hver Swift-utvikler vet At språket har stort potensial, som i sin tur kan gi mye kompleksitet, gjøre koden sammenflettet og vanskelig å lese og vedlikeholde. Derfor er Kjernemålet Med Swift-kodestil å redusere denne kompleksiteten ved å beskrive god og dårlig praksis for Å skrive Swift-kode.

Hvorfor gjør koden enklere å lese er så viktig?

Ifølge Robert C. Martin er tiden vi bruker på å lese koden over 10x mer enn å skrive den. Videre leser vi hele tiden eksisterende kode for å skrive den nye.

En annen forskning fra Fakta Og Feil i Software Engineering sier at 40%-80% av den totale programkostnaden går til vedlikehold.

la oss oppsummere fordelene Som Swift style guide gir:

  • Hjelper med å forstå prosjektstrukturen.
  • Forbedrer kodelesbarheten.
  • gjør vedlikehold enklere.
  • Raskere onboarding for nye teammedlemmer.
  • Gir muligheten til a mestre beste programmeringspraksis.
  • Blir et kommunikasjonsverktøy mellom programmerere i samfunnet.

på grunn av en så stor innvirkning blir kodingskonvensjoner vanligvis vedtatt AV IT-organisasjoner og til og med hele programmeringssamfunn.

Å Designe en kodestil fra bunnen av er en ikke-triviell oppgave og krever konsolidert innsats. Heldigvis, Som Swift-utviklere trenger vi ikke å gjenoppfinne hjulet og kan bruke flere eksisterende Swift-stilguider.

la oss utforske De mest fremtredende Swift-kodestilene mer detaljert.

Utforske Swift-Kodestiler

definisjonen av god kodestil er subjektiv Og min personlige anbefaling er å utdype flere stiler og forme dem i henhold til prosjektets behov. Listen nedenfor er her for å hjelpe.

1. Swift.org

denne veiledningen er standard som standard I Swift-fellesskapet. Det konsoliderer absolutt minimum sett av regler som Hver Swift utvikler må forstå og følge.

guiden fokuserer på grunnleggende aspekter Av Swift API design som følges av alle systemrammer. Ikke bare vil det gjøre koden ser organisk i forbindelse med system Apier, men også gjøre det enklere å lese og forstå Cocoa rammer.

På egen hånd, Swift.org kodestil er ikke nok til a gi et omfattende sett med regler, men det gjor et flott tillegg til de andre guidene som er oppfort nedenfor.

Lenke: Swift.org kode stil

2. Google

du kommer vanligvis ikke over ‘Google’ og ‘Swift’ i en setning, men ikke denne gangen. Google forstår utvilsomt betydningen av kodekonvensjoner og skaper konvensjoner for alle store åpen kildekode-prosjekter, som nevnt I Google Style Guides. Min gjetning er at Vi skal takke TensorFlow for Denne Raske guiden.

Denne Swift kode stil imponerer med sin helhet. Den dekker så mange aspekter som bare liste dem her ville gjøre denne artikkelen dobbelt så lang.

det som virkelig er verdifullt med denne veiledningen er at hvert punkt er godt grunnlagt ved å notere gode programmeringspraksiser som ofte er grunnleggende for alle språk. Programmering Praksis delen, som jeg anbefaler å lese om du er ute Etter En Rask guide eller ikke, virkelig skinner i dette aspektet.

etter å ha lest og forstått denne guiden vil du finne deg selv en bedre programmerer generelt, samt legge til En haug Med Raske triks i lommen.

Lenke: Google Swift-kodestil

3. Ray Wenderlich

teamet bak raywenderlich.com er kjent i iOS-samfunnet og trenger ikke en spesiell introduksjon. Samme Som Rays artikler gjør, er guiden skrevet på en klar og forståelig måte og er spesielt egnet for Swift nykommere

denne guiden når utvilsomt de oppgitte målene om å være klar, konsekvent og kort. Hver regel følges av en fullstendig forklaring, resonnement og et sett med eksempler med dos and don ‘ ts.

det jeg elsker om denne veiledningen, er at det går utover Swift-syntaks – og kodeformatering og forklarer god programmeringspraksis, for eksempel unngåelse av ubrukt kode, forklarer forskjellen mellom verdi-og referansetyper, begrepene lat initialisering, tilgangskontroll, tidlig retur og mye mer.

På det tidspunktet jeg skriver denne artikkelen, har den allerede 137 lukkede trekkforespørsler som viser at guiden er tungt støttet av samfunnet.

Lenke: Ray Wenderlich Swift kode stil

4. LinkedIn

LinkedIn gjør en god jobb med å åpne sourcing sine interne komponenter, Og Swift er ikke et unntak. Deres Swift style guide har eksistert i over 3 år og innlemmet mye forbedring fra både åpen kildekode-fellesskap og LinkedIn-team.

LinkedIn Swift guide er kort, konsis og godt strukturert. Korte teoretiske forklaringer er ofte gitt for å bedre forstå begrunnelsen bak visse regler. Eksemplene er alltid selvforklarende og viser tydelig poenget.

guiden fokuserer primært på kodeformatering, og jeg anbefaler å bruke den i kombinasjon med Andre Swift-kodestiler fra denne listen.

Lenke: LinkedIn Rask kodestil

5. Airbnb

Airbnb-teamet er kjent for sitt verdifulle bidrag til iOS-fellesskapet. På den tiden jeg skriver denne artikkelen, Er Airbnb Swift Style Guide bare 1 uke gammel, noe som gjør den til den ferskeste i denne listen.

fra begynnelsen setter guiden riktig kontekst ved å forklare hvorfor du trenger en kodestil, og jeg er helt enig med hvert punkt.

guiden er en glede å lese: den er godt strukturert og reglene er nøyaktig forklart. Hvor det er fornuftig, er hvert punkt ledsaget av eksempler på dos og dont og teoretisk kontekst. Nesten hver regel er gjort lintable Med SwiftLint – en statisk analysator verktøy som vil bli diskutert noen avsnitt nedenfor.

jeg liker Spesielt Mønstre delen Der Airbnb gir praktiske Raske råd som jeg anbefaler å sjekke. For eksempel foreskriver det å bruke uforanderlige verdier i stedet for foranderlige og gir tips om enums definisjon. Min favoritt er håndtering av uventede forhold der bruken av påstander, forutsetninger og fatale feil er forklart i stor detalj.

guiden gir Selv xcode editor innstillinger for å tilfredsstille reglene Fra Formatering delen som lett kan brukes være hjelp av et skript.

Link: Airbnb Swift Style Guide

Swift Kode Linter SwiftLint

vi er alle mennesker og bevisst eller ikke, vi alle gjør feil. Det er således ikke nok å dokumentere eller muntlig bli enige Om Swift-kodingskonvensjoner. For å minimere antall feil, må reglene håndheves av et automatisert verktøy, kjent som linter.

Linter er en statisk kodeanalysator som finner programmeringsfeil, feil, formateringsfeil og potensielt skadelige konstruksjoner.

SwiftLint Er Den mest brukte Swift-kodeanalysatoren som kan konfigureres basert på egendefinerte regler. Hvis du ikke bruker Det allerede, anbefaler jeg å sjekke SwiftLint og begynne å bruke Det i Swift prosjekter så snart som mulig.

Det viktigste å forstå Om SwiftLint er at Den ikke håndhever en ‘single true style’ , men bidrar til å være konsekvent i et prosjekt.

Sammendrag

Ensartede kodekonvensjoner bidrar til programmeringsproduktivitet mye, og vi vil alltid være så produktive som mulig.

listen med De mest bemerkelsesverdige Swift-kodestiler er en god kilde Til Swift beste praksis og et utgangspunkt for å utdype ditt eget sett med konvensjoner.

God Swift-kodestil er subjektiv og bør overlates til deg og lagets vurdering. Når det er godkjent og dokumentert, slik stil blir en standard og må være konsekvent på tvers av prosjektet for å forbedre lesbarheten som resulterer i mange fordeler.

SwiftLint Er et allment vedtatt verktøy I Swift samfunnet som bidrar til å håndheve koding konvensjoner. Det bidrar til å unngå menneskelige feil tidlig og kan være et verdifullt tillegg til prosjektets verktøystabel.

Legg igjen en kommentar

Din e-postadresse vil ikke bli publisert.