Come produrre una documentazione giochi per bambini (con una combinazione di html e codice swift)?

Question

Qualcuno ha capito un bel modo per produrre un documento simile al GuidedTour.giochi per bambini con un mix di html sezioni e codice swift senza doverlo fare manualmente?

Siamo in grado di esplorare il contenuto dei giochi di file che è un pacchetto e si vede html/swift file e contenuti.xcplayground file xml che descrive la struttura, ma sarebbe bello essere in grado di creare in modo user-friendly.

Answer 1

A partire dalla versione 6.3 Questa funzione è ora parte di Xcode.

Citazione dalla versione Nota:

.

Autocarro di documentazione migliorata con commenti contrassegnati in linea, risultati del parco giochi in linea, la possibilità di visualizzare e modificare le risorse incorporate nei parchi giochi e la possibilità di integrare i file di origine ausiliaria nei campi da gioco.Queste caratteristiche consentono la creazione di nuove esperienze nuove nei parchi giochi.

Answer 2

Sebbene la risposta attualmente contrassegnata come "corretta" potrebbe essere stata vera al momento della scrittura, ci sono in realtà diversi modi per farlo.

.
• Markdown: swift-playground-builderTagCode di Jason Sandmeyer è disponibile su GitHub a https://github.com/jas/Swift-Playground-Builder e può essere installato con npm install -g swift-playground-builder.Inoltre ha una riga di comando può anche essere programmata programmaticamente da JavaScript e quindi chiamato da Gulp pure (richiede node.js e npm)
• Asciidoc: James Carlson's ad2play è disponibile su GitHub a https://github.com/jxxcarlson/ad2play e può essere eseguito come Script Ruby (richiede Ruby e Asciidoctor installato)

Answer 3

Aprire la cartella giochi in Sublime o un IDE.È necessario modificare il .xcplayground estensione di file all'interno di quella .giochi cartella dove si inserisce documentation tag destra prima o dopo swift code tag.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<playground version='3.0' sdk='macosx'>
    <sections>
        <code source-file-name='section-1.swift' hidden="true" />
        <documentation relative-path='fragment0.html'/>
        <code source-file-name='section-3.swift'/>
        <documentation relative-path='fragment11.html'/>
        <code source-file-name='section-5.swift'/>
        <documentation relative-path='fragment21.html'/>
        <code source-file-name='section-7.swift'/>
        <documentation relative-path='fragment22.html'/>
        <code source-file-name='section-9.swift'/>
        <documentation relative-path='fragment23.html'/>
        <code source-file-name='section-11.swift'/>
        <documentation relative-path='fragment24.html'/>
        <code source-file-name='section-13.swift'/>
        <documentation relative-path='fragment25.html'/>
        <code source-file-name='section-15.swift'/>
        <documentation relative-path='fragment26.html'/>
        <code source-file-name='section-17.swift'/>
        <documentation relative-path='fragment27.html'/>
        <code source-file-name='section-19.swift'/>
        <documentation relative-path='fragment31.html'/>
        <code source-file-name='section-21.swift'/>
        <documentation relative-path='fragment32.html'/>
        <code source-file-name='section-23.swift'/>
        <documentation relative-path='fragment33.html'/>
    </sections>
    <timeline fileName='timeline.xctimeline'/>
</playground>

La documentazione e Swift struttura di file e cartelle devono essere come questo.

Answer 4

Sono abbastanza sicuro che non ci sia un flusso di lavoro automatizzato (almeno nessuno pubblico) disponibile per ora.Ma perché non creare il tuo se ne hai davvero bisogno?

.
• Puoi usare il Great Toolflow-Automation Tool Grunt ( http://gruntjs.com ) che è abbastanza spesso usato nel settore web.
• Puoi scrivere il tuo piccolo script / app (perché non in Swift stesso: D) per analizzare il tuo file DOC personalizzato (con una sintassi predefinita per contrassegnare le sezioni di codice e documentazione).

Entrambe le modi sono fattibili per me, ma la domanda è ovviamente se ne vale la pena.