Como produzir uma documentação parque infantil (mistura de html e código swift)?
-
22-12-2019 - |
Pergunta
Alguém já descobriu uma boa maneira de produzir um documento semelhante ao GuidedTour.parque infantil com uma mistura de html seções e código swift sem ter que fazer isso manualmente?
Podemos explorar o conteúdo do playground do arquivo, que é um pacote e ele mostra html/swift arquivos e conteúdo.xcplayground arquivo xml descrevendo a estrutura, mas seria bom ser capaz de criar um em uma forma amigável.
Solução 4
A partir da versão 6.3 Este recurso agora faz parte do Xcode.
Quote da versão Nota:
.A criação de documentação aprimorada com comentários marcados inline, resultados de playground inline, a capacidade de visualizar e editar recursos incorporados nos playgrounds e a capacidade de integrar arquivos de origem auxiliar em playgrounds.Essas características permitem a criação de novas experiências ricas em playgrounds.
Outras dicas
Embora a resposta marcado como 'correto' pode ter sido verdade no momento da escrita, na verdade, existem várias formas de o fazer.
- Markdown:Jason Sandmeyer do
swift-playground-builder
está disponível no GitHub em https://github.com/jas/swift-playground-builder e pode ser instalado comnpm install -g swift-playground-builder
.Como bem tem de ter uma linha de comando também pode ser programaticamente invocados a partir de JavaScript e, portanto, chamado a partir de um Gole bem (requer Node.JS e NPM) - Asciidoc:James Carlson s
ad2play
está disponível no GitHub em https://github.com/jxxcarlson/ad2play e pode ser executado como um Rubi scriipt (requer Ruby e asciidoctor instalado)
Abrir o parque pasta na Sublime ou uma IDE.Você precisa editar o .xcplayground extensão de arquivo dentro .parque infantil pasta, como tal, onde você insere documentation
tag direito, antes ou depois de swift code
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>
A documentação e a Swift estrutura de arquivos e pastas precisa ser assim.
Tenho certeza que não há fluxo de trabalho automatizado (pelo menos nenhum público) disponível por enquanto.Mas por que não criar o seu próprio se você realmente precisar?
- Você pode usar o grande ferramenta de fluxo de trabalho-automação grunhadura ( http://gnuntjs.com ) que é bastante usado na indústria da web.
- Você pode escrever seu próprio pequeno script / aplicativo (por que não em si mesmo: D) Analisar seu arquivo documento personalizado (com uma sintaxe predefinida para marcar as seções de código e documentação).
Ambas meas costura viável para mim, mas a questão é, é claro, se vale a pena.