liittyessäsi uuteen projektiin tai lukiessasi avointa lähdekoodia, sinun on täytynyt huomata, että jotkut projektit ovat yhdenmukaisesti järjestettyjä ja hyvin jäsenneltyjä, kun taas toiset ovat sotkuisia ja sotkuisia? Jos teemme yhteenvedon tekijöistä, jotka tuottavat tällaisen vaikutuksen koodipohjaan, törmäämme koodikäytännön käsitteeseen.

Let ’ s discover:

  • mitä koodikäytännöt ovat?
  • miten niiden hyväksymisestä voi koitua valtavasti hyötyä projektillesi?
  • mikä on SwiftLint?
  • ja mitkä Swiftin koodityylit valita?

Defining Swift Code Convention

Code convention on joukko käskyjä ja kieltoja, jotka kuvaavat tiedostojen organisaatiota, ohjelmointikäytäntöjä, suunnittelumalleja, arkkitehtuurista lähestymistapaa jne. Se voi olla muodollinen sääntökokonaisuus, jota joukkue, organisaatio tai yksilö noudattaa, tai olla yhtä epämuodollinen kuin tapa soveltaa tiettyjä koodauskäytäntöjä.

Koodityyli on koodikäytännön osajoukko, joka säätelee tiedostojen muotoilua, kuten sisennystä, pilkun paikkaa, henkseleitä, kapitaatiota jne. Swift-yhteisössä ei yleensä tehdä eroa näiden kahden välillä ja käytetään yhteistä termiä Swift code style Tai joskus Swift style guide.

tältä koodauskonventiot saattavat näyttää:

  • tiedoston nimeäminen: tiedostolla, joka sisältää yhden tyypin, on oltava sama nimi kuin tyypillä.
  • rivin pituusraja: yksi koodirivi saa olla enintään 160 merkkiä.
  • nimeäminen: muuttujat ovat lowerCamelCase.

Miksi käyttää Swift-koodin tyyliä

jokainen Swiftin kehittäjä tietää, että kielellä on valtava potentiaali, joka puolestaan voi tuoda paljon monimutkaisuutta, tehdä koodista takkuista ja vaikeasti luettavaa ja ylläpidettävää. Siksi Swift-koodin tyylin keskeisenä tavoitteena on vähentää tätä monimutkaisuutta kuvaamalla Swift-koodin kirjoittamisen hyviä ja huonoja käytäntöjä.

miksi koodin helppolukuisuus on niin tärkeää?

Robert C. Martinin mukaan koodin lukemiseen kuluu yli 10x enemmän aikaa kuin sen kirjoittamiseen. Lisäksi luemme jatkuvasti olemassa olevaa koodia, jotta voimme kirjoittaa uuden.

toinen ohjelmistotekniikan faktoista ja harhaluuloista tehty tutkimus toteaa, että 40-80% ohjelman kokonaiskustannuksista menee ylläpitoon.

tehdään yhteenveto hyödyistä, joita Swiftin tyyliopas tuottaa:

  • auttaa ymmärtämään projektin rakennetta.
  • parantaa koodin luettavuutta.
  • helpottaa huoltoa.
  • nopeuttaa uusien tiimiläisten lautailua.
  • antaa mahdollisuuden hallita parhaita ohjelmointikäytäntöjä.
  • tulee kommunikointivälineeksi ohjelmoijien välillä yhteisössä.

näin suuren vaikutuksen vuoksi KOODAUSKÄYTÄNTÖJÄ omaksuvat yleensä IT-organisaatiot ja jopa kokonaiset ohjelmointiyhteisöt.

koodaustyylin suunnittelu tyhjästä on ei-triviaali tehtävä ja vaatii koottuja ponnisteluja. Onneksi Swift-kehittäjinä meidän ei tarvitse keksiä pyörää uudelleen ja voimme hyödyntää useita olemassa olevia Swift-tyylioppaita.

tutustutaan tarkemmin Swiftin merkittävimpiin koodaustyyleihin.

Exploring Swift Code Styles

hyvän koodityylin määritelmä on subjektiivinen ja henkilökohtainen suositukseni on kehittää useita tyylejä ja muokata niitä projektisi tarpeiden mukaan. Alla olevasta listasta on apua.

1. Swift.org

tämä opas on oletusarvoisesti standardi Swift-yhteisössä. Se vahvistaa vähimmäissäännöt, jotka jokaisen Swiftin kehittäjän on ymmärrettävä ja noudatettava.

oppaassa keskitytään Swift API-suunnittelun perustaviin näkökohtiin, joita noudatetaan kaikissa järjestelmäkehyksissä. Ei vain se tekee koodi näyttää orgaaninen yhdessä järjestelmän API, mutta myös helpottaa lukea ja ymmärtää kaakao kehyksiä.

yksinään, Swift.org koodin tyyli ei riitä tarjoamaan kattavia sääntöjä, mutta se on loistava lisä muihin alla lueteltuihin oppaisiin.

linkki: Swift.org koodin tyyli

2. Google

ei yleensä törmää sanoihin ”Google” ja ”Swift” yhdessä lauseessa, mutta ei tällä kertaa. Google epäilemättä ymmärtää koodikäytäntöjen merkityksen ja luo konventioita kaikkiin suuriin avoimen lähdekoodin projekteihin, kuten Googlen Tyylioppaissa todetaan. Veikkaan, että meidän pitäisi kiittää Tensorflow ’ ta tästä nopeasta oppaasta.

tämä Swift code-tyyli tekee vaikutuksen kattavuudellaan. Se kattaa niin monia näkökohtia, että yksinkertaisesti listaamalla ne täällä tekisi tämän artikkelin kaksi kertaa niin pitkä.

tässä oppaassa on todella arvokasta se, että jokainen kohta on perusteltu luettelemalla hyviä ohjelmointikäytäntöjä, jotka ovat usein kaikkien kielten peruskäytäntöjä. Ohjelmointikäytännöt osio, jonka suosittelen lukemaan, etsitpä nopeaa opasta tai et, todella loistaa tässä suhteessa.

luettuasi ja ymmärrettyäsi tämän oppaan löydät itsesi yleisesti paremmaksi ohjelmoijaksi ja lisäät taskuusi joukon nopeita temppuja.

linkki: Google Swift-koodin tyyli

3. Ray Wenderlich

taakse jäänyt joukkue raywenderlich.com on tunnettu iOS-yhteisössä eikä tarvitse erityistä esittelyä. Samoin kuin Ray: n artikkelit, opas on kirjoitettu selkeällä ja ymmärrettävällä tavalla, ja se sopii erityisesti Swift newcomers

tämä opas epäilemättä saavuttaa asetetut tavoitteet olla selkeä, johdonmukainen ja lyhyt. Jokaista sääntöä seuraa täydellinen selitys, päättely ja joukko esimerkkejä käskyillä ja kielloilla.

mitä rakastan tässä oppaassa, on se, että menee Swift syntaksi ja koodin muotoilu ja selittää hyviä ohjelmointikäytäntöjä, kuten välttäminen käyttämättömän koodin, selittää eron arvo-ja viitetyyppien välillä, käsitteet laiska alustus, kulunvalvonta, varhainen palautus ja paljon muuta.

kun kirjoitan tätä artikkelia, sillä on jo 137 suljettua pull-pyyntöä, mikä osoittaa, että yhteisö tukee opasta voimakkaasti.

linkki: Ray Wenderlich Swift code style

4. LinkedIn

LinkedIn tekee hienoa työtä sisäisten komponenttien avoimissa hankinnoissa, eikä Swift ole poikkeus. Heidän Swift style guide on ollut olemassa yli 3 vuotta ja sisällytetty paljon parannuksia sekä avoimen lähdekoodin yhteisön ja LinkedIn joukkue.

LinkedIn Swift-opas on lyhyt, tiivis ja hyvin jäsennelty. Lyhyitä teoreettisia selityksiä tarjotaan usein, jotta voidaan paremmin ymmärtää tiettyjen sääntöjen taustalla olevia perusteluja. Esimerkit ovat aina itsestään selviä ja osoittavat selvästi asian ytimen.

opas keskittyy ensisijaisesti koodin muotoiluun ja suosittelen sitä käytettäväksi yhdessä muiden Swift-koodityylien kanssa tästä luettelosta.

linkki: LinkedIn Swift-koodin tyyli

5. Airbnb

Airbnb-tiimi on tunnettu arvokkaasta panoksestaan iOS-yhteisölle. Tällä hetkellä olen kirjallisesti tämän artikkelin, Airbnb Swift Style Guide on vain 1 viikon vanha, mikä tekee siitä tuorein tässä luettelossa.

alusta alkaen opas asettaa oikean kontekstin selittämällä, miksi tarvitaan koodityyliä, ja olen täysin samaa mieltä jokaisesta kohdasta.

opasta on ilo lukea: se on hyvin jäsennelty ja säännöt on selitetty tarkasti. Jos se on järkevää, jokainen piste on liitetty esimerkkejä dos ja dont n ja teoreettinen yhteydessä. Lähes jokainen sääntö on nukkainen swiftlint-staattinen analysaattori työkalu, jota käsitellään muutaman kohdan alla.

pidän erityisesti Patterns-osiosta, jossa Airbnb antaa käytännön Swift-neuvoja, jotka suosittelen tarkistamaan. Esimerkiksi, se prescripts käyttää muuttumattomia arvoja sijaan mutable ja antaa vinkkejä enums määritelmä. Suosikkini on odottamattomien olosuhteiden käsittely, jossa vakuuttelujen, ennakkoehtojen ja kohtalokkaiden virheiden käyttö selitetään hyvin yksityiskohtaisesti.

opas tarjoaa jopa Xcode editor-asetukset, jotka täyttävät muotoiluosaston säännöt, joita voidaan helposti soveltaa skriptin avulla.

linkki: Airbnb Swift-tyyliopas

Swift-koodi Linter SwiftLint

me kaikki olemme ihmisiä ja tarkoituksellisesti tai ei, me kaikki teemme virheitä. Ei siis riitä, että dokumentoidaan tai suullisesti sovitaan Swift-koodauskäytännöistä. Virheiden määrän minimoimiseksi sääntöjä on valvottava automatisoidulla työkalulla, joka tunnetaan nimellä linter.

Linter on staattisen koodin analysaattori, joka löytää ohjelmointivirheitä, bugeja, muotoiluvirheitä ja mahdollisesti haitallisia konstruktioita.

SwiftLint on yleisimmin käytetty Swift-koodianalysaattori, joka voidaan määrittää mukautettujen sääntöjen perusteella. Jos et käytä sitä jo, suosittelen swiftlintin tarkistamista ja aloittamaan sen käytön Swift-projekteissasi mahdollisimman pian.

tärkeintä on ymmärtää Swiftlintistä se, että se ei pakota ”yhtä oikeaa tyyliä”, vaan auttaa olemaan johdonmukainen projektissa.

Yhteenveto

yhtenäiset koodikäytännöt edistävät ohjelmoinnin tuottavuutta paljon ja haluamme aina olla mahdollisimman tuottavia.

merkittävimpiä Swift-koodaustyylejä sisältävä lista on loistava lähde Swiftin parhaille käytännöille ja lähtökohta omien konventioiden tarkentamiselle.

hyvä Swift-koodityyli on subjektiivinen ja se tulisi jättää sinun ja tiimisi harkinnan varaan. Kun se on hyväksytty ja dokumentoitu, tällaisesta tyylistä tulee standardi, ja sen on oltava johdonmukainen koko hankkeessa luettavuuden parantamiseksi, mikä johtaa lukuisiin hyötyihin.

SwiftLint on Swift-yhteisössä laajalti hyväksytty työkalu, joka auttaa valvomaan koodauskäytäntöjä. Se auttaa välttämään inhimillisiä virheitä varhaisessa vaiheessa ja voi olla arvokas lisä projektisi työkalupakkaan.

Vastaa

Sähköpostiosoitettasi ei julkaista.