amikor új projekthez csatlakozik vagy nyílt forráskódot olvas, észre kell vennie, hogy egyes projektek egységesen szervezettek és jól strukturáltak, míg mások rendetlenek és kusza? Ha összefoglaljuk azokat a tényezőket, amelyek ilyen hatást fejtenek ki a kódbázis felett, akkor találkozunk a kódkonvenció fogalmával.

fedezze fel:

  • mik azok a kód konvenciók?
  • hogyan vezethet az örökbefogadás hatalmas előnyökkel a projekt számára?
  • mi az a SwiftLint?
  • és melyik Swift kódstílust válassza?

a Swift kód konvenció meghatározása

a kód konvenció a fájlok szervezését, programozási gyakorlatokat, tervezési mintákat, építészeti megközelítést stb. Ez lehet egy formális szabálykészlet, amelyet egy csapat, szervezet vagy egyén követ, vagy ugyanolyan informális lehet, mint bizonyos kódolási gyakorlatok alkalmazásának szokása.

a Kódstílus a fájlformázást szabályozó kódmegállapodások részhalmaza, például behúzás, vesszők, zárójelek, nagybetűk stb. A Swift közösségben a kettő közötti különbséget általában nem teszik meg, és a Swift kódstílus vagy néha a Swift stílus útmutató kifejezést használják.

így nézhetnek ki a kódolási konvenciók:

  • fájlnév: az egyetlen típust tartalmazó fájlnak ugyanazzal a névvel kell rendelkeznie, mint a típusnak.
  • sorhossz-korlát: egyetlen kódsor nem haladhatja meg a 160 karaktert.
  • elnevezés: a változók lowerCamelCase.

miért érdemes használni a Swift Kódstílust

minden Swift Fejlesztő tudja, hogy a nyelv hatalmas potenciállal rendelkezik, ami viszont sok bonyolultságot hozhat, a kódot összekuszálhatja, nehezen olvasható és karbantartható. Ezért a Swift kód stílus fő célja, hogy csökkentse ezt a komplexitást a Swift kód írásának jó és rossz gyakorlatainak leírásával.

miért olyan fontos a kód könnyebb olvasása?

Robert C. Martin szerint a kód olvasásával töltött idő több mint 10x több, mint az írás. Továbbá folyamatosan olvassuk a meglévő kódot annak érdekében, hogy megírjuk az újat.

a Facts and Falacies of Software Engineering egy másik kutatása szerint a teljes programköltség 40-80% – a megy karbantartásra.

összefoglaljuk a Swift stílus útmutató előnyeit:

  • segít megérteni a projekt szerkezetét.
  • javítja a kód olvashatóságát.
  • megkönnyíti a karbantartást.
  • felgyorsítja a beszállást az új csapattagok számára.
  • lehetőséget ad a legjobb programozási gyakorlatok elsajátítására.
  • kommunikációs eszközzé válik a közösség programozói között.

egy ilyen hatalmas hatás miatt a kódolási konvenciókat általában informatikai szervezetek, sőt egész programozási közösségek fogadják el.

a kódstílus tervezése a semmiből nem triviális feladat, és konszolidált erőfeszítéseket igényel. Szerencsére Swift fejlesztőként nem kell újra feltalálnunk a kereket, és több meglévő Swift stílus útmutatót is felhasználhatunk.

vizsgáljuk meg részletesebben a legkiemelkedőbb Swift kódolási stílusokat.

a Swift Kódstílusok feltárása

a jó kódstílus meghatározása szubjektív, és személyes javaslatom az, hogy több stílust dolgozzon ki, és alakítsa őket a projekt igényeinek megfelelően. Az alábbi lista itt segít.

1. Swift.org

ez az útmutató alapértelmezés szerint a Swift közösség szabványa. Egységesíti az abszolút minimális szabályokat, amelyeket minden Swift fejlesztőnek meg kell értenie és követnie kell.

az útmutató a Swift API tervezésének alapvető szempontjaira összpontosít, amelyet minden rendszerkeret követ. Nem csak ez teszi a kódot organikus együtt rendszer API-k, hanem megkönnyíti az olvasást és megérteni Cocoa keretek.

önmagában, Swift.org a kódstílus nem elegendő egy átfogó szabályrendszer biztosításához, de remekül kiegészíti az alább felsorolt többi útmutatót.

Link: Swift.org kód stílus

2. Google

általában nem találkozol a ‘Google’ – val és a ‘Swift’ – el egy mondatban, de ezúttal nem. A Google kétségtelenül megérti a kódkonvenciók fontosságát, és konvenciókat hoz létre minden nagyobb nyílt forráskódú projekt számára, amint azt a Google Stílus útmutatója is kimondja. Azt hiszem, meg kell köszönnünk a TensorFlow-nak ezt a gyors útmutatót.

ez a Swift kódstílus lenyűgözi átfogó jellegét. Olyan sok szempontot fed le, hogy egyszerűen felsorolva őket, ez a cikk kétszer olyan hosszú lenne.

ami igazán értékes ebben az útmutatóban, az az, hogy minden pont jól megalapozott a jó programozási gyakorlatok felsorolásával, amelyek gyakran minden nyelv számára megalapozottak. A programozási gyakorlatok szakasz, amelyet nagyon ajánlom elolvasni, függetlenül attól, hogy gyors útmutatót keres-e vagy sem, valóban ragyog ebben a vonatkozásban.

miután elolvasta és megértette ezt az útmutatót, általában jobb programozót talál magának, valamint egy csomó gyors trükköt ad a zsebébe.

Link: Google Swift kód stílus

3. Ray Wenderlich

a csapat mögött raywenderlich.com az iOS közösségben jól ismert, és nem igényel külön bevezetést. Csakúgy, mint Ray cikkei, az útmutató világos és érthető módon íródott, és különösen alkalmas a Swift újonnan érkezők számára

ez az útmutató kétségtelenül eléri a kitűzött célokat, hogy világos, következetes és rövid legyen. Minden szabályt követ egy teljes magyarázat, érvelés és egy sor példa a dos és a don ‘ ts.

amit szeretek ebben az útmutatóban, az az, hogy túlmutat a gyors szintaxison és a kódformázáson, és elmagyarázza a jó programozási gyakorlatokat, mint például a fel nem használt kód elkerülése, elmagyarázza az érték és a referencia típusok közötti különbséget, a lusta inicializálás, a hozzáférés-vezérlés, a korai visszatérések és még sok más.

abban az időben, amikor ezt a cikket írom, már 137 zárt húzási kérelmet tartalmaz, ami azt mutatja, hogy az útmutatót a közösség erősen támogatja.

Link: Ray Wenderlich Swift kód stílus

4. LinkedIn

a LinkedIn nagyszerű munkát végez a belső komponensek nyílt beszerzésében, és a Swift sem kivétel. A Swift style guide már több mint 3 éve létezik, és rengeteg fejlesztést tartalmazott mind a nyílt forráskódú közösség, mind a LinkedIn csapat részéről.

a LinkedIn Swift Útmutató rövid, tömör és jól strukturált. Gyakran rövid elméleti magyarázatokat adnak az egyes szabályok mögött meghúzódó érvelés jobb megértése érdekében. A példák mindig magától értetődőek és világosan mutatják a lényeget.

az útmutató elsősorban a kódformázásra összpontosít, és nagyon ajánlom, hogy a listán szereplő más Swift kódstílusokkal együtt használja.

Link: LinkedIn Swift kód stílus

5. Airbnb

Airbnb csapat jól ismert, hogy értékes hozzájárulást iOS közösség. Abban az időben írom ezt a cikket, Airbnb Swift stílus útmutató csak 1 hetes mi teszi a legfrissebb ebben a listában.

az útmutató a kezdetektől fogva meghatározza a megfelelő kontextust azzal, hogy elmagyarázza, miért van szükség kódstílusra, és teljesen egyetértek minden ponttal.

az útmutató öröm olvasni: jól felépített és a szabályokat pontosan elmagyarázták. Ahol van értelme, minden pontot a DOS és a dont példái, valamint az elméleti kontextus kíséri. Szinte minden szabály készül lintable SwiftLint-statikus elemző eszköz, amely lesz szó néhány bekezdést alább.

különösen szeretem a minták részt, ahol az Airbnb gyakorlati gyors tanácsokat ad, amelyeket nagyon ajánlom ellenőrizni. Például előírja, hogy változhatatlan értékeket használjon a változtatható helyett, és tippeket ad az enums definíciójához. Kedvencem a váratlan körülmények kezelése, ahol az állítások, előfeltételek és végzetes hibák használatát részletesen elmagyarázom.

az útmutató még az Xcode szerkesztő beállításait is biztosítja, hogy megfeleljen a formázási szakasz szabályainak, amelyek könnyen alkalmazhatók egy szkript eszközeként.

Link: Airbnb Swift stílus útmutató

Swift kód Linter SwiftLint

mindannyian emberek vagyunk, és szándékosan vagy sem, mindannyian hibázunk. Így nem elegendő dokumentálni vagy szóban megegyezni a Swift kódolási konvenciókról. A hibák számának minimalizálása érdekében a szabályokat egy automatizált eszközzel, linter néven kell végrehajtani.

a Linter egy statikus kódelemző, amely programozási hibákat, hibákat, formázási hibákat és potenciálisan káros konstrukciókat talál.

a SwiftLint a legszélesebb körben használt Swift kódelemző, amely egyéni szabályok alapján konfigurálható. Ha még nem használja, nagyon ajánlom a SwiftLint ellenőrzését, és a lehető leghamarabb kezdje el használni a Swift projektjeiben.

a legfontosabb dolog, amit meg kell érteni a Swiftlintről, hogy nem érvényesíti az egyetlen valódi stílust, hanem segít abban, hogy következetes legyen egy projekten belül.

Összegzés

az egységes kód konvenciók nagyban hozzájárulnak a programozás termelékenységéhez, és mindig a lehető legtermékenyebbek akarunk lenni.

a legfontosabb Swift kódolási stílusokat tartalmazó lista nagyszerű forrása a Swift legjobb gyakorlatainak, és kiindulópont a saját konvenciók kidolgozásához.

a jó Swift-kód stílus szubjektív, ezért Önre és csapatára kell bízni. Miután jóváhagyták és dokumentálták, ez a stílus standarddá válik, és a projekt egészében következetesnek kell lennie az olvashatóság javítása érdekében, ami számos előnnyel jár.

a SwiftLint egy széles körben elfogadott eszköz a Swift közösségben, amely segít a kódolási egyezmények érvényesítésében. Segít elkerülni az emberi hibákat Korán, és értékes kiegészítője lehet A projekt eszközkészletének.

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.