Nach einigen Recherchen über die beste Möglichkeit, schnellen Code zu dokumentieren. Ich stieß auf Jazzy und wie einfach es umzusetzen war. Also folge ich dem Installationsabschnitt der Jazzy Documentation. Ich betreibeJazzy funktioniert nicht wie erwartet, um eine schnelle Dokumentation zu erstellen
sudo gem install jazzy
Dann habe ich an der Wurzel meines Projekts navigieren, in dem Terminal, und führen Sie jazzy, die einen Ordner „Dokumente“ mit einer Website namens erstellt, die Dokumentation für 1-Klasse zeigt. Ich habe 87 Klassen, die ich im Terminalausgang sichtbar durch jazziges Durchschleifen sehen kann.
Ich habe die NSHipster Tutorial über Dokumentationscode gelesen, der Sie auch mit der Jazzy Documentation sowie der Markup Formatting Reference verbindet. Ich habe Code dokumentiert, den Xcode korrekt im Seitenfenster anzeigt oder mit der rechten Maustaste auf die Funktion oder Klasse klickt. Ich bin ziemlich sicher, dass meine Syntax korrekt ist.
Ich brauchte einige Zeit, um diese 1 Datei mit der anderen Datei zu vergleichen, die nicht angezeigt wird, und ich sehe nichts außergewöhnliches in Bezug auf Format.
Ich bin mit:
- jazzigen Version: 0.3.2
- Xcode Version: 7.1
- Swift Version: 2.1
- OS X El Capitan Version: 10,11
Meine Gesamtfrage ist; Warum erstellt jazzy keine Dokumentation für alle Klassen und wie kann ich dieses Problem beheben?
oo Dank, ich war verärgert, wie es aus wie 68% sagten, dokumentiert –
Und gibt es eine Möglichkeit, alle ACL zu dokumentieren (öffentlich, privat, intern?) Wenn ich '--min-acl internal 'verwende, sehe ich die öffentlichen Methoden nicht dokumentiert. –
Fügen Sie eine Dokumentation zum Anfang der Klasse hinzu, und es wird funktionieren –