Ich entschuldige mich für die Einfachheit meiner Frage, aber ich habe versucht, Dokumentation mit Appledocs ( Ссылка ) zu erstellen.
Ich bin mir nicht sicher, wie genau es eingerichtet werden soll. So wie ich es mache:
Wie aber benutze ich das eigentlich in dem Sinne, dass ich mein Projekt in xcode:
habeWas ich immer tue, ist, meinem Projekt ein neues Ziel hinzuzufügen, das Dokumentation erzeugen kann. Sie können zu den Projektbauphasen gehen und auf "Ziel hinzufügen" klicken. Wählen Sie Aggregieren unter Andere und geben Sie ihm einen Namen (z. B. ProjectDocumentation).
Gehen Sie auf der Registerkarte Build-Phasen noch zu "Build-Phase hinzufügen" und klicken Sie auf "Run-Skript hinzufügen". Sie können jetzt Folgendes einfügen und an Ihre eigenen Einstellungen anpassen:
%Vor%Ich benutze die ignore * .m, weil ich nur Dokumentation in meine Header-Dateien schreibe. Dokumentation in meinen * .m-Dateien ist nur für mich (und somit privat). Wenn Sie dieses Ziel erstellen, wird die Dokumentation als XCode-Dokument erstellt. Dies erreichen Sie, indem Sie bei alt-klicken auf einen Klassennamen klicken. Besuchen Sie die AppleDoc-Website , um die Syntax zu kommentieren.
Zur Erläuterung der Befehlszeilenoptionen checken Sie den Befehl appledoc --help.
Die empfohlene Methode ist clone GitHub project and compile the tool from Xcod e. Während das Klonen von GitHub-Projekten die Verbindung zum Haupt-Repository herstellt, vereinfacht dies auch das zukünftige Upgrade erheblich. Geben Sie Folgendes in das Terminal ein, um es zu installieren:
Dies erstellt appledoc-Verzeichnis. Innerhalb finden Sie appledoc.xcodeproj Xcode Projekt; Öffnen Sie es und kompilieren Sie appledoc target - dies sollte sofort funktionieren, Ihr System muss jedoch die Mindestsystemanforderungen erfüllen, siehe unten. Ich empfehle Ihnen, die resultierende ausführbare appledoc-Datei aus dem Build-Verzeichnis in eines der Verzeichnisse in Ihrem Pfad (echo $ PATH) zu kopieren, um es leicht zugänglich zu machen.
Optional: Appledoc ist eigenständig und enthält die erforderlichen Vorlagendateien. WENN Sie diese Standardeinstellungen aus dem Unterverzeichnis Templates in einen der erwarteten Speicherorte ändern möchten:
%Vor%für weitere Informationen besuchen
Tags und Links objective-c ios xcode documentation-generation code-documentation