när du går med i ett nytt projekt eller läser en öppen källkod måste du ha märkt att vissa projekt är enhetligt organiserade och välstrukturerade, medan andra är röriga och trassliga? Om vi sammanfattar de faktorer som ger en sådan effekt över kodbasen, stöter vi på begreppet kodkonvention.

låt oss upptäcka:

  • vad är kodkonventioner?
  • hur deras antagande kan leda till stora fördelar för ditt projekt?
  • Vad är SwiftLint?
  • och vilka Swift – kodstilar att välja?

definiera Swift Code Convention

Code convention är en uppsättning dos och inte göra som beskriver filer organisation, programmeringsmetoder, designmönster, arkitektoniska tillvägagångssätt, etc. Det kan vara en formell uppsättning regler som följs av ett team, organisation eller individ, eller vara så informell som en vana att tillämpa vissa kodningsmetoder.

Kodstil är en delmängd av kodkonventionen som styr filformatering, såsom indrag, placering av kommatecken, hängslen, kapitalisering etc. I Swift-samhället görs vanligtvis inte skillnaden mellan de två och den vanliga termen Swift-kodstil eller ibland Swift-stilguide används.

så här kan kodningskonventioner se ut:

  • filnamn: en fil som innehåller en enda typ måste ha samma namn som typen gör.
  • Linjelängdsgräns: en enda rad kod bör inte överstiga 160 tecken.
  • Namngivning: variablerna är lowerCamelCase.

Varför använda Swift-Kodstil

varje Swift-utvecklare vet att språket har stor potential, vilket i sin tur kan ge mycket komplexitet, göra kod trasslig och svår att läsa och underhålla. Därför är Kärnmålet med Swift – kodstil att minska denna komplexitet genom att beskriva bra och dåliga metoder för att skriva Swift-kod.

Varför är det så viktigt att göra koden lättare att läsa?

enligt Robert C. Martin är tiden vi spenderar på att läsa koden över 10x mer än att skriva den. Dessutom läser vi ständigt befintlig kod för att skriva den nya.

en annan forskning från fakta och felaktigheter i programvaruteknik säger att 40% -80% av den totala programkostnaden går till underhåll.

låt oss sammanfatta fördelar som Swift style guide ger:

  • hjälper till att förstå projektstrukturen.
  • förbättrar kodläsbarheten.
  • underlättar underhållet.
  • snabbar upp onboarding för nya teammedlemmar.
  • ger möjlighet att behärska bästa programmeringspraxis.
  • blir ett kommunikationsverktyg mellan programmerare i samhället.

på grund av en så stor inverkan antas kodningskonventioner vanligtvis av IT-organisationer och till och med hela programmeringsgemenskaper.

att designa en kodstil från grunden är en icke-trivial uppgift och kräver konsoliderade ansträngningar. Lyckligtvis, som Swift-utvecklare behöver vi inte uppfinna hjulet på nytt och kan använda flera befintliga Swift-stilguider.

Låt oss utforska de mest framträdande Swift-kodningsstilarna mer detaljerat.

utforska Swift – Kodstilar

definitionen av bra kodstil är subjektiv och min personliga rekommendation är att utarbeta flera stilar och forma dem enligt dina projektbehov. Listan nedan är här för att hjälpa.

1. Swift.org

den här guiden är en standard som standard i Swift community. Det konsoliderar den absoluta minsta uppsättning regler som varje Swift utvecklare måste förstå och följa.

guiden fokuserar på grundläggande aspekter av Swift API-design som följs av alla systemramar. Inte bara det kommer att göra din kod ser organisk i samband med systemet API, men också göra det lättare att läsa och förstå kakao ramar.

på egen hand, Swift.org kod stil är inte tillräckligt för att ge en omfattande uppsättning regler, men det gör ett bra komplement till de andra guider som anges nedan.

länk: Swift.org kod stil

2. Google

du stöter normalt inte på ’Google ’ och’ Swift ’ i en mening, men inte den här gången. Google förstår utan tvekan vikten av kodkonventioner och skapar konventioner för alla större open source-projekt, som anges i Googles stilguider. Min gissning är att vi borde tacka TensorFlow för denna snabba guide.

denna Swift – kodstil imponerar med sin omfattning. Det täcker så många aspekter som helt enkelt listar dem här skulle göra den här artikeln dubbelt så lång.

det som verkligen är värdefullt med den här guiden är att varje punkt är välgrundad genom att lista goda programmeringsmetoder som ofta är grundläggande för alla språk. Avsnittet programmeringspraxis, som jag starkt rekommenderar att läsa om du letar efter en snabb guide eller inte, lyser verkligen i denna aspekt.

efter att ha läst och förstått den här guiden hittar du dig själv en bättre programmerare i allmänhet samt lägger till en massa snabba knep i fickan.

länk: Google Swift kod stil

3. Ray Wenderlich

laget bakom raywenderlich.com är välkänd i iOS community och behöver inte en speciell introduktion. Samma som Rays artiklar gör, guiden är skriven på ett tydligt och förståeligt sätt och är särskilt lämplig för snabba nykomlingar

denna guide når utan tvekan de angivna målen att vara tydliga, konsekventa och korta. Varje regel följs av en fullständig förklaring, resonemang och en uppsättning exempel med dos och don ’ ts.

vad jag älskar med den här guiden är att det går utöver Swift-syntax och kodformatering och förklarar god programmeringspraxis, såsom undvikande av oanvänd kod, förklarar skillnaden mellan värde-och referenstyper, begreppen Lat initialisering, åtkomstkontroll, tidig avkastning och mycket mer.

när jag skriver den här artikeln har den redan 137 stängda pull-förfrågningar som visar att guiden stöds starkt av samhället.

länk: Ray Wenderlich Swift kod stil

4. LinkedIn

LinkedIn gör ett bra jobb med att öppna sina interna komponenter och Swift är inte ett undantag. Deras Swift style guide har funnits i över 3 år och införlivat massor av förbättringar från både open source-community och LinkedIn-team.

LinkedIn Swift guide är kort, koncis och välstrukturerad. Korta teoretiska förklaringar ges ofta för att bättre förstå resonemanget bakom vissa regler. Exemplen är alltid självförklarande och visar tydligt punkten.

guiden fokuserar främst på kodformatering och jag rekommenderar starkt att använda den i kombination med andra Swift-kodstilar från den här listan.

länk: LinkedIn Swift kod stil

5. Airbnb

Airbnb-teamet är känt för sitt värdefulla bidrag till iOS-communityn. När jag skriver den här artikeln är Airbnb Swift Style Guide bara 1 vecka gammal, vilket gör den till den färskaste i den här listan.

från början sätter guiden rätt sammanhang genom att förklara varför du behöver en kodstil och jag håller helt med varje punkt.

guiden är ett nöje att läsa: den är välstrukturerad och reglerna förklaras exakt. Där det är vettigt åtföljs varje punkt med exempel på dos och donts och teoretiska sammanhang. Nästan varje regel görs linterbar med SwiftLint – ett statiskt analysatorverktyg som kommer att diskuteras några stycken nedan.

jag gillar särskilt mönster avsnitt där Airbnb ger praktiska Swift råd som jag rekommenderar att kontrollera. Till exempel, det prescripts att använda oföränderliga värden i stället för föränderlig och ger tips om enums definition. Min favorit är hanteringen av oväntade förhållanden där användningen av påståenden, förutsättningar och dödliga fel förklaras i detalj.

guiden ger även Xcode editor inställningar för att uppfylla reglerna från avsnittet formatering som lätt kan tillämpas vara medel för ett skript.

länk: Airbnb Swift Style Guide

Swift Code Linter SwiftLint

vi är alla människor och medvetet eller inte, vi gör alla misstag. Således räcker det inte att dokumentera eller muntligt komma överens om Swift-kodningskonventioner. För att minimera antalet misstag måste reglerna tillämpas av ett automatiserat verktyg, känt som linter.

Linter är en statisk kodanalysator som hittar programmeringsfel, buggar, formateringsfel och potentiellt skadliga konstruktioner.

SwiftLint är den mest använda Swift – kodanalysatorn som kan konfigureras baserat på anpassade regler. Om du inte använder det redan rekommenderar jag starkt att du kontrollerar SwiftLint och börjar använda det i dina Swift-projekt så snart som möjligt.

det viktigaste att förstå om SwiftLint är att det inte genomdriver en enda sann stil utan hjälper till att vara konsekvent inom ett projekt.

sammanfattning

enhetliga kodkonventioner bidrar mycket till programmeringsproduktiviteten och vi vill alltid vara så produktiva som möjligt.

listan med mest anmärkningsvärda Swift-kodningsstilar är en bra källa till Swift best practices och en utgångspunkt för att utarbeta din egen uppsättning konventioner.

bra Swift – kodstil är subjektiv och bör lämnas på dig och ditt lags övervägande. När den är godkänd och dokumenterad blir en sådan stil en standard och måste vara konsekvent över hela projektet för att förbättra läsbarheten vilket resulterar i många fördelar.

SwiftLint är ett allmänt antaget verktyg i Swift community som hjälper till att genomdriva kodningskonventioner. Det hjälper till att undvika mänskliga misstag tidigt och kan vara ett värdefullt tillägg till projektets verktyg stack.

Lämna ett svar

Din e-postadress kommer inte publiceras.