Kommentarvorlagen für Methoden in Xcode

In der Softwareentwicklung ist gut kommentierter Programmcode oft die Grundlage für eine ausführliche Projektdokumentation. Obwohl es immer erwähnt wird, sind Kommentare trotzdem noch ein Thema, das von vielen Programmierern vernachlässig wird. Wenn es Kommentare gibt, verwenden Entwickler oft einen individuellen Stil. Ein Projekt, an dem mehrere Personen arbeiten, wird dann schnell/leicht unübersichtlich.

Die Entwicklungsumgebung Xcode bietet inzwischen eine Funktion, die beim Kommentieren von Methoden tatkräftig unterstützt. Leider verbringt sich diese Hilfe, wie nicht selten bei Apple, hinter einem komplexen Tastenkürzel. In diesem Fall ist es cmd + alt + / und das ist eine Tastenkombination, die auf deutschen Tastaturen nur schwer zu erreichen ist. Um ein / einzugeben muss gleichzeitig die Shit-Taste betätigt werden und in dieser Kombination, löst Xcode die gewünschte Funktion nicht aus. Zum Glück lässt sich diese Tastenbelegung ändern, und zwar in den Einstellungen der Entwicklungsumgebung unter Key Bindings. Dort findet man die beschriebene Funktion leicht, wenn man nach »add doc« sucht. Jetzt ist es kein Problem mehr, die Tastenkombination zu ändern. Zum Beispiel auf cmd + alt + 7.

Platziert man den Cursor jetzt vor einer Methode und betätigt die Tastenkombination, wird von Xcode ein vorbereiteter Kommentar eingefügt. Erstellt werden Platzhalter für sämtliche Parameter der Methode, zusammen mit einem Platzhalter, um eine Beschreibung für den Code einzufügen. Jetzt sollte es keine Herausforderung mehr sein, alle Methoden ausreichend und einheitlich zu kommentieren. Mit der Tabulator-Taste kann zwischen den verschiedenen Platzhaltern navigiert werden. Die Kommentarvorlagen funktionieren für die Sprachen Swift, SwiftUI und Objective-C.

Geschrieben am: 29.09.2020
Technologien: Swift, SwiftUI, macOS, iOS, Xcode, Objective-C