Wie erstelle ich einen Dokumentationsspielplatz (HTML und Swift Code mischen)?
Hat jemand eine gute Möglichkeit gefunden, ein Dokument ähnlich dem GuidedTour.playground mit einer Mischung aus HTML-Abschnitten und schnellem Code zu erstellen, ohne es manuell machen zu müssen?
Wir können den Inhalt der Playground-Datei, die ein Paket ist, untersuchen und es zeigt html / swift-Dateien und eine contents.xcplayground xml-Datei, die die Struktur beschreibt, aber es wäre schön, diese benutzerfreundlich erstellen zu können .
4 Antworten
Ab Version 6.3 ist diese Funktion jetzt Teil von Xcode.
Zitat aus der Release Note:
Verbesserte Dokumentationserstellung mit inline-markierten Kommentaren, Inline-Spielplatz-Ergebnissen, der Möglichkeit, in Spielplätzen eingebettete Ressourcen anzuzeigen und zu bearbeiten sowie die Möglichkeit, zusätzliche Quelldateien in Playgrounds zu integrieren. Diese Funktionen ermöglichen die Schaffung von reichen neuen Erfahrungen auf Spielplätzen.
Auch wenn die Antwort zur Zeit als ‚richtigen‘ markiert den zum Zeitpunkt des Schreibens wahr gewesen sein mag, es gibt in der Tat mehrere Möglichkeiten, dies zu tun.
- Markdown: Jason Sandmeyer die
swift-playground-builderist auf GitHub verfügbar unter Ссылка und installiert werden kannnpm install -g swift-playground-builder. Neben einer Befehlszeile hat hat, kann es auch programmatisch von JavaScript und daher von Gulp auch genannt aufgerufen werden (erfordert Node.JS und NPM) - asciidoc: James Carlson
ad2playist auf GitHub verfügbar unter Ссылка und als Ruby-scriipt ausgeführt werden können (erfordert Ruby und asciidoctor installiert)
Öffnen Sie den Spielplatz Ordner in Sublime oder eine IDE. Sie müssen die .xcplayground-Erweiterungsdatei in diesem .playground-Ordner als solche bearbeiten, in die Sie documentation tag direkt vor oder nach dem swift code -Tag einfügen.
Die Dokumentation und die Swift-Datei- und Ordnerstruktur müssen so sein.
Ich bin mir ziemlich sicher, dass momentan kein automatisierter Workflow (zumindest kein öffentlicher) verfügbar ist. Aber warum nicht eigene erstellen, wenn Sie es wirklich brauchen?
- Sie können das groß Workflow-Automatisierungs-Tool Grunt ( Ссылка ), die sehr oft in der web- verwendet wird Industrie.
- Sie können Ihr eigenes kleines Skript / app (warum nicht in swift selbst: D) schreiben. Ihre benutzerdefinierten doc-Datei (mit einer vordefinierten Syntax Code- und Dokumentations Abschnitte markieren) zu analysieren
Beide Wege sind für mich machbar, aber die Frage ist natürlich, ob es das wert ist.
Tags und Links swift swift-playground