Cómo producir una documentación de juegos (mezcla de html y código swift)?

Question

Alguien ha descubierto una manera agradable para producir un documento similar a la GuidedTour.zona de juegos con una mezcla de html y secciones de código swift sin tener que hacerlo manualmente?

Podemos explorar el contenido de el patio de recreo de archivo que es un paquete y se muestra html/swift de archivos y un contenido.xcplayground archivo xml que describe la estructura, pero sería agradable ser capaz de crear uno de una manera amigable para el usuario.

Answer 1

A partir de la versión 6.3 Esta función es ahora parte de Xcode.

Cita de la marca Nota:

La autorización de documentación mejorada con los comentarios marcados en línea, los resultados del parque infantil en línea, la capacidad de ver y editar recursos incorporados en patios de recreo y la capacidad de integrar archivos de origen auxiliares en áreas de juegos.Estas características permiten la creación de nuevas experiencias ricas en áreas de juego.

Answer 2

Aunque la respuesta en la actualidad marcada como 'correcto' puede haber sido cierto en el momento de la escritura, de hecho, hay varias maneras de hacer esto.

• Rebajas:Jason Sandmeyer del swift-playground-builder está disponible en GitHub en https://github.com/jas/swift-playground-builder y puede ser instalado con npm install -g swift-playground-builder.Como bien ha de tener una línea de comandos también puede ser mediante programación se invoca desde JavaScript y por lo tanto llamado de Gulp así (requiere Node.JS y NPM)
• Asciidoc:James Carlson del ad2play está disponible en GitHub en https://github.com/jxxcarlson/ad2play y se puede ejecutar como un Rubí scriipt (requiere Ruby y asciidoctor instalado)

Answer 3

Abra la carpeta de juegos en Sublime o un IDE.Usted tendrá que editar el .xcplayground extensión de archivo dentro de ese marco .zona de juegos de la carpeta, como tal, donde se inserta documentation la etiqueta antes o después de swift code de la etiqueta.

<?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 documentación y Swift estructura de archivos y carpetas deben ser como este.

Answer 4

Estoy bastante seguro de que no hay ningún flujo de trabajo automatizado (al menos no hay uno público) disponible por ahora.Pero, ¿por qué no creas el tuyo si realmente lo necesitas?

• Puede usar el Great Workflow-Automation Tool Grunt ( http://gruntjs.com )) que se usa con bastante frecuencia en la industria web.
• Puede escribir su propio pequeño script / aplicación (por qué no en Swift en sí: D) Para analizar su archivo DOC personalizado (con una sintaxis predefinida para marcar las secciones de código y documentación).

Tanto maneras de la costura factible para mí, pero la pregunta es, por supuesto, si vale la pena.