Sto leggendo sull'articolo come generare una documentazione HTML simile a Apple al here. Le mie domande sono a cosa servono le righe di comando. Come possiamo combinare le righe di comando e il progetto xcode di appledoc per generare un codice HTML.come utilizzare appledoc per generare una documentazione di tipo Apple
Non ho usato "appledoc", ma da una rapida occhiata alla pagina che hai collegato sembra che sia un'utilità da riga di comando open-source. Quindi il primo passo sarà compilare il programma 'appledoc' stesso, e poi incollarlo in una directory che è nel tuo percorso, come ad esempio /usr/local/bin o ~/bin/.
Il passaggio successivo è provare a utilizzarlo per generare della documentazione (supponendo che tu abbia già creato i file di markdown che consuma). Aprire una finestra di terminale, passare alla directory in cui i file sono, e quindi utilizzare il comando dato nella parte superiore della pagina che si è collegato:
appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .
Se si desidera utilizzare 'appledoc' per rigenerare la documentazione di ogni Quando crei un progetto, puoi aggiungere una fase di build "Esegui script" a un target esistente nel tuo progetto, o creare un nuovo target solo per la documentazione che non ha altro che una fase di build "Esegui script". In entrambi i casi, lo script in quella fase dovrebbe essere uno script di shell contenente un comando simile a quello sopra (anche se probabilmente vorrai specificare la directory di origine esplicitamente piuttosto che usare semplicemente la directory 'corrente', ad esempio .).
Sono l'autore di Appledoc Tool. Lo strumento è destinato ad essere utilizzato come risposta da Caleb sopra. Il metodo di installazione consigliato è quello di clonare il repository da GitHub, aprire il progetto in Xcode, creare e copiare facoltativamente il binario sul percorso come suggerito sopra. Inoltre, è necessario copiare anche i file modello richiesti per l'esecuzione dello strumento su uno dei percorsi predefiniti. Tutti i passaggi richiesti sono descritti nel file Leggimi nella pagina di Appledoc su GitHub, vedere la sezione Installazione rapida.
ci sono anche altri metodi per l'installazione - tutti i contributi da parte degli utenti:
install-appledoc.sh script incluso nel repository git.Per ulteriori domande, vedere appledoc Google group. L'ho appena creato pochi giorni fa, quindi non ci sono contenuti al momento della stesura di questo articolo, ma sentitevi liberi di fare domande lì.
Come ho trovato su questo post, è possibile generare una documentazione HTML completo del vostro codice con questa riga di comando:
appledoc --project-name BabelCPP --project-azienda "My Name" - -company-id com.mycompany --no-create-docset --output ./doc/.
L'ultimo "." è il percorso del tuo codice.
Dubito che la maggior parte delle persone abbia familiarità con il progetto 'appledoc', quindi potresti voler spiegare la tua domanda un po 'di più. – Caleb