dołączając do nowego projektu lub czytając kod open source, musisz zauważyć, że niektóre projekty są jednolicie zorganizowane i dobrze zorganizowane, podczas gdy inne są niechlujne i splątane? Jeśli podsumujemy czynniki, które dają taki wpływ na podstawę kodu, natkniemy się na pojęcie konwencji kodu.

odkryjmy:

  • czym są konwencje kodu?
  • jak ich przyjęcie może przynieść ogromne korzyści dla Twojego projektu?
  • Co To jest SwiftLint?
  • i jakie style kodu Swift wybrać?

Definiowanie Konwencji kodu Swift

konwencja kodu to zestaw nakazów i zakazów, które opisują organizację plików, praktyki programowania, wzorce projektowe, podejście architektoniczne itp. Może to być formalny zestaw zasad, których przestrzega zespół, organizacja lub osoba, lub być tak nieformalny, jak nawyk stosowania pewnych praktyk kodowania.

styl kodu jest podzbiorem konwencji kodu, która reguluje formatowanie plików, takie jak wcięcia, pozycja przecinków, nawiasy klamrowe, wielkie litery itp. W społeczności Swift rozróżnienie między nimi zwykle nie jest dokonywane, A używany jest wspólny termin Swift code style lub czasami Swift style guide.

oto jak mogą wyglądać konwencje kodowania:

  • nazwa pliku: plik zawierający pojedynczy typ musi mieć taką samą nazwę jak typ.
  • limit długości linii: pojedyncza linia kodu nie powinna przekraczać 160 znaków.
  • nazewnictwo: zmienne to lowerCamelCase.

dlaczego warto używać stylu kodu Swift

każdy programista Swift wie, że język ma ogromny potencjał, który z kolei może przynieść wiele złożoności, sprawić, że kod będzie splątany i trudny do odczytania i utrzymania. Dlatego głównym celem stylu kodu Swift jest zmniejszenie tej złożoności poprzez opisanie dobrych i złych praktyk pisania kodu Swift.

dlaczego tak ważne jest ułatwianie czytania kodu?

według Roberta C. Martina czas, jaki spędzamy na czytaniu kodu jest ponad 10x większy niż jego pisanie. Co więcej, cały czas czytamy istniejący kod w celu napisania nowego.

kolejne badania z Faktów i błędów Inżynierii Oprogramowania wskazują, że 40% -80% całkowitych kosztów programu idzie na konserwację.

podsumujmy korzyści, jakie przynosi Swift style guide:

  • pomaga zrozumieć strukturę projektu.
  • poprawia czytelność kodu.
  • ułatwia konserwację.
  • przyspiesza wdrażanie nowych członków zespołu.
  • daje możliwość opanowania najlepszych praktyk programistycznych.
  • staje się narzędziem komunikacji między programistami w społeczności.

ze względu na tak ogromny wpływ, konwencje kodowania są zwykle przyjmowane przez organizacje IT, a nawet całe społeczności programistyczne.

projektowanie stylu kodu od podstaw jest nietrywialnym zadaniem i wymaga skonsolidowanych wysiłków. Na szczęście, jako Programiści Swift nie musimy odkrywać koła na nowo i możemy korzystać z wielu istniejących przewodników po stylu Swift.

przyjrzyjmy się bardziej szczegółowo najbardziej znanym stylom kodowania Swift.

odkrywanie stylów kodu Swift

definicja dobrego stylu kodu jest subiektywna, a moja osobista rekomendacja to opracowanie wielu stylów i kształtowanie ich zgodnie z potrzebami projektu. Poniższa lista jest tutaj, aby pomóc.

1. Swift.org

ten przewodnik jest standardem domyślnie w społeczności Swift. Konsoliduje absolutny minimalny zestaw reguł, które każdy programista Swift musi zrozumieć i przestrzegać.

przewodnik skupia się na podstawowych aspektach projektowania Swift API, po których podążają wszystkie frameworki systemowe. Nie tylko sprawi, że Twój kod będzie wyglądał organicznie w połączeniu z interfejsami API systemu, ale także ułatwi czytanie i zrozumienie frameworków Cocoa.

Swift.org styl kodu nie wystarczy, aby zapewnić kompleksowy zestaw reguł, ale stanowi świetny dodatek do innych przewodników wymienionych poniżej.

Link: Swift.org styl kodu

2. Google

zwykle nie natykasz się na „Google” i „Swift” w jednym zdaniu, ale nie tym razem. Google bez wątpienia rozumie znaczenie konwencji kodu i tworzy konwencje dla każdego większego projektu open-source, jak stwierdzono w przewodnikach po stylach Google. Myślę, że powinniśmy podziękować TensorFlow za ten Szybki przewodnik.

ten styl kodu Swift zachwyca swoją wszechstronnością. Obejmuje tak wiele aspektów, że po prostu wymienienie ich tutaj sprawi, że ten artykuł będzie dwa razy dłuższy.

to, co jest naprawdę cenne w tym przewodniku, to to, że każdy punkt jest dobrze ugruntowany, wymieniając dobre praktyki programistyczne, które często są fundamentalne dla wszystkich języków. Sekcja praktyk programistycznych, którą gorąco polecam przeczytać niezależnie od tego, czy szukasz szybkiego przewodnika, czy nie, naprawdę świeci w tym aspekcie.

po przeczytaniu i zrozumieniu tego przewodnika znajdziesz się lepszym programistą w ogóle, jak również dodać kilka szybkich sztuczek do kieszeni.

Link: styl kodu Google Swift

3. Ray Wenderlich

zespół za raywenderlich.com jest dobrze znany w społeczności iOS i nie wymaga specjalnego wprowadzenia. Podobnie jak artykuły Raya, przewodnik jest napisany w jasny i zrozumiały sposób i jest szczególnie odpowiedni dla szybkich nowicjuszy

ten przewodnik niewątpliwie osiąga określone cele, aby być jasnym, spójnym i krótkim. Każda reguła jest poprzedzona kompletnym wyjaśnieniem, rozumowaniem i zestawem przykładów z dos i don ’ ts.

to, co kocham w tym przewodniku, to to, że wykracza poza szybką składnię i formatowanie kodu i wyjaśnia dobre praktyki programistyczne, takie jak unikanie nieużywanego kodu, wyjaśnia różnicę między typami wartości i odniesień, koncepcje leniwej inicjalizacji, kontroli dostępu, wczesnych zwrotów i wiele więcej.

w momencie pisania tego artykułu ma on już 137 zamkniętych pull requestów, co pokazuje, że przewodnik jest mocno wspierany przez społeczność.

Link: Ray Wenderlich Swift code style

4. LinkedIn

LinkedIn świetnie sprawdza się w open sourcingu ich wewnętrznych komponentów, A Szybkie nie są wyjątkiem. Ich Szybki przewodnik po stylu istnieje od ponad 3 lat i zawiera wiele ulepszeń zarówno ze strony społeczności open source, jak i zespołu LinkedIn.

LinkedIn Swift guide jest krótki, zwięzły i dobrze zorganizowany. Krótkie wyjaśnienia teoretyczne są często dostarczane w celu lepszego zrozumienia rozumowania niektórych zasad. Przykłady są zawsze oczywiste i wyraźnie pokazują punkt.

przewodnik koncentruje się przede wszystkim na formatowaniu kodu i Gorąco polecam używać go w połączeniu z innymi stylami kodu Swift z tej listy.

Link: LinkedIn Swift code style

5. Airbnb

zespół Airbnb jest dobrze znany ze swojego cennego wkładu w społeczność iOS. W chwili pisania tego artykułu Airbnb Swift Style Guide ma zaledwie 1 tydzień, co czyni go najświeższym na tej liście.

od samego początku przewodnik ustawia odpowiedni kontekst, wyjaśniając, dlaczego potrzebujesz stylu kodu i całkowicie zgadzam się z każdym punktem.

poradnik jest przyjemny do czytania: jest dobrze zorganizowany, a zasady są dokładnie wyjaśnione. Tam, gdzie ma to sens, każdemu punktowi towarzyszą przykłady dos i dont oraz kontekst teoretyczny. Prawie każda reguła jest lintable z SwiftLint – narzędzie Analizator statyczny, który zostanie omówiony kilka akapitów poniżej.

szczególnie podoba mi się sekcja wzorów, w której Airbnb daje praktyczne porady, które Gorąco polecam sprawdzić. Na przykład, nakazuje używać niezmiennych wartości zamiast mutowalnych i zawiera wskazówki dotyczące definicji wyliczeń. Moim ulubionym jest obsługa nieoczekiwanych warunków, w których stosowanie twierdzeń, warunków wstępnych i błędów krytycznych jest bardzo szczegółowo wyjaśnione.

przewodnik zawiera nawet ustawienia edytora Xcode, aby spełnić reguły z sekcji formatowania, które można łatwo zastosować za pomocą skryptu.

Link: Airbnb Swift Style Guide

Swift Code Linter SwiftLint

wszyscy jesteśmy ludźmi i celowo czy nie, wszyscy popełniamy błędy. Nie wystarczy zatem dokumentować lub werbalnie uzgadniać konwencje kodowania Swift. Aby zminimalizować liczbę błędów, reguły muszą być egzekwowane przez zautomatyzowane narzędzie, znane jako linter.

Linter to statyczny analizator kodu, który znajduje błędy programowania, błędy formatowania i potencjalnie szkodliwe konstrukcje.

SwiftLint jest najczęściej używanym analizatorem kodu Swift, który można skonfigurować na podstawie niestandardowych reguł. Jeśli jeszcze go nie używasz, Gorąco polecam sprawdzenie SwiftLint i jak najszybciej zacznij go używać w swoich projektach Swift.

najważniejszą rzeczą do zrozumienia o SwiftLint jest to, że nie wymusza „jednego prawdziwego stylu”, ale pomaga być spójnym w ramach projektu.

podsumowanie

jednolite konwencje kodu bardzo przyczyniają się do produktywności programowania i zawsze chcemy być jak najbardziej produktywni.

lista z najbardziej godnymi uwagi stylami kodowania Swift jest doskonałym źródłem najlepszych praktyk Swift i punktem wyjścia do opracowania własnego zestawu konwencji.

dobry styl kodu Swift jest subiektywny i powinien zostać pozostawiony Tobie i Twojemu zespołowi. Po zatwierdzeniu i udokumentowaniu taki styl staje się standardem i musi być spójny w całym projekcie, aby poprawić czytelność, co skutkuje licznymi korzyściami.

SwiftLint jest powszechnie przyjętym narzędziem w społeczności Swift, które pomaga egzekwować konwencje kodowania. Pomaga wcześnie uniknąć ludzkich błędów i może być cennym dodatkiem do stosu narzędzi projektu.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.