Xcode 8 automatisch generierte Schnellhilfedokumentation

84

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

"Automatische Generierung der Quick Help-Dokumentation":

Geben Sie hier die Bildbeschreibung ein

Ist dies das Ende der manuellen Codedokumentation, wie wir sie in diesem Artikel von NSHipster lernen können ?

Kann jemand die Vor- und Nachteile dieser neuen Funktion skizzieren? Ersetzt es Werkzeuge wie Jazzy ?

Ich konnte keine weiteren Informationen zu der neuen Funktion finden.

xcode swift xcode8 H4Hugo
quelle
@ Rob: Irgendeine Idee, wie ich sehen könnte, wie es aussieht, ohne den Schmerz zu haben, Xcode 8 bêta zu installieren und es gleich danach zu deinstallieren (nicht autorisiert, es auf dem Mac meines Jobs zu installieren)
H4Hugo
Es wird in einigen WWDC 2016-Videos gezeigt.
Rob
1
developer.apple.com/videos/play/wwdc2016/102
Rob
2
Sie können eine Demo im Video um 37:00 Uhr sehen - aber ich kann sie nicht zum Laufen bringen! Ich habe es mit Swift und Obj-C versucht und mit verschiedenen Teilen einer Funktion ausgewählt.
Verwirrter Vorlon

Antworten:

203

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

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

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

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

Es erleichtert lediglich das Schreiben von Dokumentationen für die Schnellhilfe.

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

rauben
quelle
1
Kannst du es zum Laufen bringen? Ich kann nicht Wenn du kannst; Was wählen Sie aus, wenn Sie den Befehl verwenden? Ich habe fast jede Option ausprobiert ...
Verwirrter
2
Ich setze meinen Cursor einfach irgendwo in den Methodennamen und drücke dann Befehl + Option + "/" (sowie "Editor" - "Struktur" - "Dokumentation hinzufügen") in Xcode 8 und es funktioniert einwandfrei. Das einzige Problem, auf das ich bisher gestoßen bin, ist, dass es mit @IBActionMethoden verwechselt zu werden scheint . Aber es funktioniert sowohl mit Objective-C als auch mit Swift. Wenn Sie immer noch Probleme haben und versucht haben, Xcode neu zu starten und / oder Ihren Computer neu zu starten, möchten Sie möglicherweise nur einen Fehlerbericht zu dieser Beta-Software veröffentlichen.
Rob
2
Ich habe gerade einen Neustart versucht, aber immer noch keine Freude. Ich habe einen Fehlerbericht eingereicht.
Verwirrter Vorlon
5
Es funktioniert tatsächlich ab Xcode 8 Beta 1, aber wenn Sie El Capitan verwenden, müssen Sie Xcode starten, die erforderlichen Systemkomponenten installieren und dann sudo /usr/libexec/xpccachectlim Terminal ausführen und Ihren Mac neu starten, bevor es oder andere Xcode-Erweiterungen dies tun Arbeit. Siehe die Versionshinweise zu Xcode 8.
Chris Hanson
1
Ich finde, dass es sporadisch funktioniert. Manchmal funktioniert es großartig und manchmal überhaupt nicht. Ich habe auch nicht herausgefunden warum. Ehrlich gesagt, wenn es funktioniert, finde ich die Dinge, die es automatisch generiert, ziemlich spärlich (Methodenname in der Beschreibung?). Für diejenigen von euch, dass es ohne Probleme funktioniert, super. Für einige von uns ist es sporadisch oder funktioniert einfach nicht.
Lloyd Sargent
7

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

Dh 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 derzeit leider auch nicht funktioniert, ist wahrscheinlich auf das alte XCode-Plugin VVDocumenter zurückzuführen, das genau diese Verknüpfung verwendet hat.

Tolles Feature, miese Qualitätssicherung auf der Apple-Seite.

Klaus Busse
quelle
Es gab diesen Fehler in Xcode 8 Beta, aber er wurde in der veröffentlichten Version behoben.
Eric Aya
8A218a ist die veröffentlichte Version - und die Kommentarverknüpfung funktioniert wieder für mich (nicht in Betas).
Eric Aya
Befinden Sie sich in einem Tastaturlayout, in dem Sie '/' ohne Shift erhalten?
Klaus Busse
Ja, ich habe zwei Tastaturen, eine französische Azerty-Tastatur mit "/" über ":" und eine amerikanische Qwerty-Tastatur. Beide funktionieren für die Kommentarverknüpfung in Ordnung.
Eric Aya
Nun, es ist zeitweise für mich (amerikanische Tastatur).
Lloyd Sargent