webentwicklung-frage-antwort-db.com.de

Xcode 8 automatisch generierte Hilfedokumentation

Unter den neuen Funktionen, die in Xcode 8 angekündigt wurden, können wir sehen

"Schnellhilfe-Dokumentation automatisch generieren":

enter image description here

Ist dies das Ende der manuellen Codedokumentation wie wir kann man in diesem Artikel von NSHipster lernen ?

Kann jemand die Vor- und Nachteile dieser neuen Funktion erläutern? Ersetzt es Tools wie Jazzy ?

Ich konnte keine weiteren Informationen zu der neuen Funktion finden.

77
H4Hugo

Dies bezieht sich auf die Xcode 8-Funktion (und höher), bei der Sie eine Methode wie die folgende auswählen können:

func foo(bar: Int) -> String { ... }

... und dann drücken +option+/ (oder wählen Sie "Struktur" "" Dokumentation hinzufügen "aus dem" Editor "-Menü von Xcode) und es wird die folgende Kommentarvorlage für Sie generiert:

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

Es erleichtert nur das Schreiben der Dokumentation für die Schnellhilfe.


Beachten Sie, dass sich dieses Verhalten im Laufe der Zeit etwas geändert hat. Xcode kann sich jedoch darauf beziehen, wo sich der Cursor befinden muss, wenn Sie dies versuchen. Beispielsweise muss sich der Cursor irgendwo im Funktionsnamen befinden, in meinem obigen Beispiel foo, damit dies funktioniert. Oder doppelklicken Sie einfach auf den Funktionsnamen und drücken Sie dann +option+/

184
Rob

Dies hängt höchstwahrscheinlich damit zusammen, dass ALLE Tastenkombinationen mit einem '/' im aktuellen XCode 8-Build nicht funktionieren, wenn Ihre Tastatur die Umschalttaste drücken muss, um sie abzurufen.

Das heißt auf der deutschen tastatur ist das '/' shift + 7, drücken von alt + cmd + shift-7 macht nichts. Wenn Sie z. B. cmd + shift + opt + d zuweisen, funktioniert dies einwandfrei.

Die Verknüpfung '///', die momentan leider auch nicht funktioniert, liegt wahrscheinlich am alten XCode-Plugin VVDocumenter, das genau diese Verknüpfung verwendet hat.

Tolles Feature, miese QS auf der Apple Seite.

6
Klaus Busse