Wie erstellt man einen Dokumentationsspielplatz (Mischen von HTML- und SWIFT-Code)?

Question

hat jemand eine schöne Art, ein Dokument herauszufinden, das dem Guidedtour.Playground mit einer Mischung aus HTML-Abschnitten und SWIFT-Code ähnelt, ohne es manuell tun zu müssen?

Wir können den Inhalt der Spielplatzdatei untersuchen, die ein Paket ist, und es zeigt HTML / Swift-Dateien und eine Inhalte.xcPlayground-XML-Datei, die die Struktur beschreibt, aber es wäre schön, einen benutzerfreundlichen Weg erstellen zu können.

Answer 1

ab Version 6.3 Diese Funktion ist jetzt Teil von Xcode.

Zitat aus der Version HINWEIS:

Verbesserte Dokumentationserzieher mit Inline-Micity-Anmerkungen, Inline-Spielgeräten, die Möglichkeit, Ressourcen eingebettet in Spielplätze anzuzeigen und zu bearbeiten, und die Möglichkeit, Hilfsquelldateien in Spielplätze integrieren zu können.Diese Funktionen ermöglichen die Erstellung von neuen neuen Erfahrungen in Spielplätzen.

Answer 2

Obwohl die Antwort, die derzeit als "richtig" markiert ist, kann zum Zeitpunkt des Schreibens wahr sein, es gibt tatsächlich mehrere Möglichkeiten, dies zu tun.

• Markierung: Jason Sandmeyer's swift-playground-builder ist auf Github auf https://github.com/jas/ verfügbar) verfügbar.Swift-Playground-Builder und kann mit npm install -g swift-playground-builder installiert werden.Da es sich um eine Befehlszeile aufweist, kann es auch von JavaScript programmgesteuert aufgerufen werden und daher auch von GULP aufgerufen werden (erfordert node.js und npm)
• asciidoc: James Carlsons ad2play ist auf Github bei https://github.com/jxxcarlson/ad2play <) erhältlich> und kann als Ruby-Scriips ausgeführt werden (erfordert Rubin- und Asciidoctor installiert)

Answer 3

Öffnen Sie den Playground-Ordner in Erhabene oder eine IDE.Sie müssen die Erweiterungsdatei der .xcPlayground-Erweiterungsdatei in diesem.

generasacodicetagpre.

Die Dokumentations- und Swift-Datei- und Ordnerstruktur müssen so sein.

Answer 4

Ich bin mir ziemlich sicher, dass es keinen automatisierten Workflow gibt (zumindest keine öffentliche Öffentlichkeit).Aber warum erstellen Sie nicht Ihre eigenen, wenn Sie es wirklich brauchen?

• Sie können das große Workflow-Automation-Tool Grunze verwenden ( http://gruntjs.com ) das häufig in der Web-Industrie verwendet wird.
• Sie können Ihr eigenes kleines Skript / App schreiben (warum nicht in Swift selbst: d), um Ihre benutzerdefinierte DOC-Datei zu analysieren (mit einer vordefinierten Syntax zu Markierungscode- und Dokumentationsabschnitten).

Beide Wege Naht machbar für mich, aber die Frage ist natürlich, wenn es sich lohnt.