Wie erstelle ich Dokumentation für Instanzvariable und Methoden in Xcode?
Ich möchte Alt-Click eine Instanzvariable (oder eine Methode) als Teil des Programms, das ich erstellt habe, lesen können und lesen, wozu es dient.
Die Tatsache, dass Xcode mir sagt, dass die Klassenvariable bei - deklariert ist, ist schön, aber nicht genug. In diesem Fall würde ich gerne benutzerdefinierten Text sehen, den ich eingegeben habe, um zu beschreiben, was ein asset wirklich ist. Außerdem wäre der Typ des ivars nützlich, um zu wissen.
Wie kann das gemacht werden? In diesem Fall frage ich mich was genau ich mit assets
Ich frage mich besonders, ob diese Informationen von Xcode aus betrachtet werden können, ähnlich wie Eclipse JavaDoc content anzeigt.
2 Antworten
Sie müssten einen Dokumentationssatz für Ihr Projekt erstellen und in Xcode installieren. appledoc kann Ihnen dabei helfen. Dies ist ein Befehlszeilentool, mit dem Sie Dokumentation in Apple-Stil aus speziell formatierten Kommentaren in Ihren Headern generieren können. Sie können dies auch in Ihren Build-Prozess mit einer Run-Script-Build-Phase integrieren, so dass die Dokumentation immer auf dem neuesten Stand ist.
Bei kleinen Projekten ist es normalerweise nicht den Aufwand wert und Sie sind wahrscheinlich besser dran, wenn Sie einfach Kommentare zu Ihren Header-Dateien hinzufügen und mit Cmd-Klick dorthin springen (Strg + Cmd + Pfeil nach links), um dorthin zurückzukehren, wo Sie gekommen sind von).
Sie sollten sich wahrscheinlich die Dokumentation von Apple unter Dokumentationssätze sowie deren Artikel über das Erstellen von Dokumentensets mit Doxygen . Letzteres basiert auf Xcode 3.x, also wie relevant es ist, ist etwas fragwürdig, aber es wäre eine gute Idee, trotzdem einen Blick darauf zu werfen.
Das heißt, wenn Sie sich entscheiden, Doxygen (Alternativen wie HeaderDoc kann für die Dokumentation verwendet werden, aber ich bin mir nicht sicher, was Ihnen zur Verfügung steht so weit wie das Erstellen von Doc-Sets geht), sieht es aus wie der Hauptpunkt Ich möchte GENERATE_DOCSET=YES in Ihre Doxyfile (oder wie auch immer Sie es nennen) werfen. . Danach würdet ihr die Ergebnisse einfach in ~/Library/Developer/Shared/Documentation/DocSets werfen (laut Doxygens Dokumentation). Ich weiß nicht, ob das in Xcode 4.x funktioniert - es lohnt sich aber, und es wäre nett, das wieder zu hören.
Hinweis: Das meiste basierte auf dieser Antwort von Barry Wark. Ich habe dort einen Bildkredit, da ich mich nicht darum gekümmert hätte, das hier zu betrachten, wäre da nicht seine Antwort.
Tags und Links objective-c xcode documentation-generation appledoc