Wenn Sie einem neuen Projekt beitreten oder einen Open-Source-Code lesen, müssen Sie bemerkt haben, dass einige Projekte einheitlich organisiert und gut strukturiert sind, während andere chaotisch und verwirrt sind? Wenn wir die Faktoren zusammenfassen, die einen solchen Effekt auf die Codebasis haben, stoßen wir auf den Begriff der Code-Konvention.

Entdecken Sie:

  • Was sind Code-Konventionen?
  • Wie kann ihre Einführung zu enormen Vorteilen für Ihr Projekt führen?
  • Was ist SwiftLint?
  • Und welche Swift-Code-Stile sollen ausgewählt werden?

Definieren der Swift-Code-Konvention

Die Code-Konvention ist eine Reihe von Dos und Don’ts, die die Organisation von Dateien, Programmierpraktiken, Entwurfsmuster, Architekturansatz usw. beschreiben. Es kann ein formales Regelwerk sein, das von einem Team, einer Organisation oder einer Einzelperson befolgt wird, oder es kann so informell sein wie die Gewohnheit, bestimmte Codierungspraktiken anzuwenden.

Der Codestil ist eine Teilmenge der Codekonvention, die die Dateiformatierung regelt, z. B. Einzug, Position von Kommas, geschweiften Klammern, Großschreibung usw. In der Swift-Community wird normalerweise nicht zwischen den beiden unterschieden, und der gebräuchliche Begriff Swift Code Style oder manchmal Swift Style Guide wird verwendet.

So könnten Codierungskonventionen aussehen:

  • Dateiname: Eine Datei, die einen einzelnen Typ enthält, muss denselben Namen wie der Typ haben.
  • Zeilenlängenbegrenzung: Eine einzelne Codezeile sollte 160 Zeichen nicht überschreiten.
  • Benennung: Variablen sind lowerCamelCase.

Warum Swift-Code verwenden?

Jeder Swift-Entwickler weiß, dass die Sprache ein enormes Potenzial hat, was wiederum viel Komplexität mit sich bringen, Code durcheinander bringen und schwer zu lesen und zu pflegen sein kann. Daher besteht das Kernziel des Swift-Code-Stils darin, diese Komplexität zu reduzieren, indem gute und schlechte Praktiken beim Schreiben von Swift-Code beschrieben werden.

Warum ist es so wichtig, Code leichter lesbar zu machen?

Laut Robert C. Martin ist die Zeit, die wir mit dem Lesen des Codes verbringen, über 10x mehr als das Schreiben. Darüber hinaus lesen wir ständig vorhandenen Code, um den neuen zu schreiben.

Eine weitere Studie von Facts and Fallacies of Software Engineering besagt, dass 40% -80% der gesamten Programmkosten für die Wartung aufgewendet werden.

Lassen Sie uns die Vorteile des Swift Style Guide zusammenfassen:

  • Hilft, die Projektstruktur zu verstehen.
  • Verbessert die Lesbarkeit des Codes.
  • Erleichtert die Wartung.
  • Beschleunigt das Onboarding neuer Teammitglieder.
  • Gibt die Möglichkeit, die besten Programmierpraktiken zu beherrschen.
  • Wird zu einem Kommunikationsinstrument zwischen Programmierern in der Community.

Aufgrund dieser enormen Auswirkungen werden Codierungskonventionen normalerweise von IT-Organisationen und sogar ganzen Programmiergemeinschaften übernommen.

Das Entwerfen eines Codestils von Grund auf ist eine nicht triviale Aufgabe und erfordert konsolidierte Anstrengungen. Glücklicherweise müssen wir als Swift-Entwickler das Rad nicht neu erfinden und können mehrere vorhandene Swift-Styleguides verwenden.

Lassen Sie uns die bekanntesten Swift-Codierungsstile genauer untersuchen.

Swift-Codestile erkunden

Die Definition eines guten Codestils ist subjektiv und meine persönliche Empfehlung ist, mehrere Stile zu erarbeiten und sie entsprechend Ihren Projektanforderungen zu gestalten. Die folgende Liste soll Ihnen helfen.

1. Swift.org

Dieses Handbuch ist standardmäßig ein Standard in der Swift-Community. Es konsolidiert das absolute Minimum an Regeln, die jeder Swift-Entwickler verstehen und befolgen muss.

Der Leitfaden konzentriert sich auf grundlegende Aspekte des Swift-API-Designs, denen alle System-Frameworks folgen. Es wird nicht nur Ihren Code in Verbindung mit System-APIs organisch aussehen lassen, sondern auch das Lesen und Verstehen von Cocoa-Frameworks erleichtern.

Allein, Swift.org der Codestil reicht nicht aus, um ein umfassendes Regelwerk bereitzustellen, ist jedoch eine großartige Ergänzung zu den anderen unten aufgeführten Handbüchern.

Verknüpfung: Swift.org code-Stil

2. Google

Normalerweise stoßen Sie nicht auf ‚Google‘ und ‚Swift‘ in einem Satz, aber diesmal nicht. Google versteht zweifellos die Bedeutung von Code-Konventionen und erstellt Konventionen für alle wichtigen Open-Source-Projekte, wie in Google Style Guides angegeben. Ich vermute, dass wir TensorFlow für diesen schnellen Leitfaden danken sollten.

Dieser Swift-Code-Stil besticht durch seine Vollständigkeit. Es deckt so viele Aspekte ab, dass sie diesen Artikel doppelt so lang machen würden, wenn Sie sie hier auflisten.

Was an diesem Handbuch wirklich wertvoll ist, ist, dass jeder Punkt gut begründet ist, indem gute Programmierpraktiken aufgelistet werden, die oft für alle Sprachen grundlegend sind. Der Abschnitt Programmierpraktiken, den ich dringend empfehle, um zu lesen, ob Sie nach einem Swift-Handbuch suchen oder nicht, glänzt in diesem Aspekt wirklich.

Nachdem Sie dieses Handbuch gelesen und verstanden haben, werden Sie im Allgemeinen ein besserer Programmierer sein und ein paar schnelle Tricks in Ihre Tasche stecken.

Verknüpfung: Google Swift-Code-Stil

3. Ray Wenderlich

Das Team hinter raywenderlich.com ist in der iOS-Community bekannt und bedarf keiner besonderen Einführung. Genau wie Rays Artikel ist der Leitfaden klar und verständlich geschrieben und eignet sich besonders für Swift-Neulinge

Dieser Leitfaden erreicht zweifellos die erklärten Ziele, klar, konsistent und kurz zu sein. Jede Regel wird durch eine vollständige Erklärung, Argumentation und eine Reihe von Beispielen mit Dos und Don’ts gefolgt.

Was ich an diesem Handbuch liebe, ist, dass es über die schnelle Syntax und Codeformatierung hinausgeht und gute Programmierpraktiken wie die Vermeidung von unbenutztem Code, den Unterschied zwischen Wert- und Referenztypen, die Konzepte von faule Initialisierung, Zugriffskontrolle, frühe Rückgabe und vieles mehr.

Zu der Zeit, als ich diesen Artikel schreibe, hat er bereits 137 geschlossene Pull-Anfragen, was zeigt, dass der Leitfaden stark von der Community unterstützt wird.

Verknüpfung: Ray Wenderlich Swift-Code Stil

4. LinkedIn

LinkedIn leistet hervorragende Arbeit beim Open Sourcing ihrer internen Komponenten, und Swift-Komponenten sind keine Ausnahme. Ihr Swift Style Guide existiert seit über 3 Jahren und enthält viele Verbesserungen sowohl von der Open-Source-Community als auch vom LinkedIn-Team.

LinkedIn Swift Guide ist kurz, prägnant und gut strukturiert. Oft werden kurze theoretische Erklärungen gegeben, um die Gründe für bestimmte Regeln besser zu verstehen. Die Beispiele sind immer selbsterklärend und verdeutlichen den Punkt.

Der Leitfaden konzentriert sich hauptsächlich auf die Codeformatierung und ich empfehle dringend, ihn in Kombination mit anderen Swift-Codestilen aus dieser Liste zu verwenden.

Verknüpfung: LinkedIn Swift-Code-Stil

5. Airbnb

Das Airbnb-Team ist bekannt für seinen wertvollen Beitrag zur iOS-Community. Zu der Zeit, als ich diesen Artikel schreibe, ist der Swift Style Guide nur 1 Woche alt, was ihn zum frischesten in dieser Liste macht.

Der Leitfaden stellt von Anfang an den richtigen Kontext ein, indem er erklärt, warum Sie einen Codestil benötigen, und ich stimme jedem Punkt voll und ganz zu.

Der Leitfaden ist ein Vergnügen zu lesen: Er ist gut strukturiert und die Regeln sind genau erklärt. Wo es sinnvoll ist, wird jeder Punkt mit Beispielen von Dos und Dont’s und theoretischem Kontext begleitet. Fast jede Regel ist lintable mit SwiftLint gemacht – ein statisches Analysator-Tool, das einige Absätze unten diskutiert werden.

Ich mag besonders den Abschnitt, in dem Airbnb praktische schnelle Ratschläge gibt, die ich dringend empfehlen kann. Zum Beispiel schreibt es vor, unveränderliche Werte anstelle von veränderlichen zu verwenden, und gibt Tipps zur Definition von Enums. Mein Favorit ist der Umgang mit unerwarteten Bedingungen, bei denen die Verwendung von Behauptungen, Voraussetzungen und schwerwiegenden Fehlern ausführlich erläutert wird.

Das Handbuch bietet sogar Xcode-Editor-Einstellungen, um die Regeln aus dem Formatierungsabschnitt zu erfüllen, die einfach mittels eines Skripts angewendet werden können.

Link: Airbnb Swift Style Guide

Swift Code Linter SwiftLint

Wir sind alle Menschen und absichtlich oder nicht, wir alle machen Fehler. Daher reicht es nicht aus, Swift-Codierungskonventionen zu dokumentieren oder mündlich zu vereinbaren. Um die Anzahl der Fehler zu minimieren, müssen die Regeln durch ein automatisiertes Tool namens Linter erzwungen werden.

Linter ist ein statischer Codeanalysator, der Programmierfehler, Bugs, Formatierungsfehler und potenziell schädliche Konstrukte findet.

SwiftLint ist der am weitesten verbreitete Swift-Code-Analysator, der basierend auf benutzerdefinierten Regeln konfiguriert werden kann. Wenn Sie es noch nicht verwenden, empfehle ich dringend, SwiftLint zu überprüfen und es so schnell wie möglich in Ihren Swift-Projekten zu verwenden.

Das Wichtigste an SwiftLint ist, dass es keinen einzigen wahren Stil erzwingt, sondern dazu beiträgt, innerhalb eines Projekts konsistent zu sein.

Zusammenfassung

Einheitliche Code-Konventionen tragen sehr zur Produktivität der Programmierung bei und wir wollen immer so produktiv wie möglich sein.

Die Liste mit den bemerkenswertesten Swift-Codierungsstilen ist eine großartige Quelle für Best Practices für Swift und ein Ausgangspunkt, um Ihre eigenen Konventionen zu erarbeiten.

Ein guter Swift-Code-Stil ist subjektiv und sollte Ihnen und Ihrem Team überlassen bleiben. Sobald es genehmigt und dokumentiert ist, wird ein solcher Stil zum Standard und muss im gesamten Projekt konsistent sein, um die Lesbarkeit zu verbessern, was zu zahlreichen Vorteilen führt.

SwiftLint ist ein weit verbreitetes Tool in der Swift-Community, das zur Durchsetzung von Codierungskonventionen beiträgt. Es hilft, menschliche Fehler frühzeitig zu vermeiden und kann eine wertvolle Ergänzung des Tool-Stacks Ihres Projekts sein.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.