Warum #warning in der Entwicklung wichtig ist
Swifts #warning-Direktive erzeugt eine Compiler-Warnung mit einer benutzerdefinierten Nachricht. Anders als Kommentare tauchen diese im Issue Navigator und in der Build-Ausgabe auf, sodass man sie unmöglich übersehen kann. Ich verwende sie als harte Erinnerungen für Dinge, die vor dem Release unbedingt erledigt werden müssen.
Zwei Snippets, die ich täglich nutze
Ich habe zwei Xcode Code Snippets für diesen Zweck eingerichtet.
“nyi” – Not Yet Implemented:
#warning("Not yet implemented!")Ich tippe nyi und drücke Enter, wann immer ich eine Funktion auslagere oder beim Prototyping einen Codepfad überspringe. Es kompiliert problemlos, aber die Warnung stellt sicher, dass ich zurückkomme, um die Arbeit zu beenden.
“dw” – Developer Warning:
#warning("<#message#>")Dieses Snippet verwendet ein Platzhalter-Token, sodass nach dem Tippen von dw und Drücken von Enter der Cursor in der Nachricht landet und ich eine individuelle Notiz eingeben kann. Ich verwende das für Dinge wie #warning("Handle error case for offline mode") oder #warning("Remove before release").
So erstellt man Xcode Snippets
Das Einrichten dauert jeweils etwa 30 Sekunden:
Tippe den gewünschten Code als Snippet in eine beliebige Swift-Datei
Markiere den Code
Rechtsklick und Create Code Snippet wählen
Gib ihm einen Titel (z.B. „Developer Warning”)
Setze die Completion-Abkürzung (z.B.
dw)Setze Availability auf „All” oder „Swift”
Klicke auf Done
Von da an bietet das Tippen der Abkürzung in jeder Swift-Datei das Snippet über die Autovervollständigung an.
Der entscheidende Vorteil gegenüber reinen Kommentaren ist die Sichtbarkeit. Ein // TODO:-Kommentar lässt sich leicht ignorieren und ist schwer konsistent zu finden. Ein #warning zwingt den Compiler, es bei jedem einzelnen Build anzuzeigen, und hält deine unfertige Arbeit im Vordergrund, bis du sie erledigst.