Wie Doxygen Methode Beschreibung in Xcode die autocomplete popup?
Verwendung von Xcode , möchte ich die Doxygen-Beschreibung meiner Methode unter der AutoVervollständigen-option, wie alloc
:
Beim schreiben, Xcode zeigt die AutoVervollständigen mit den Kommentaren aus der Dokumentation. Sie können im Bild sehen Sie zum Beispiel, wenn alloc
ausgewählt ist aus den Optionen, es sagt "liefert eine neue Instanz der Erhalt der Klasse" und auch die links zu der Dokumentation.
War ich in der Lage zu dokumentieren meinen source code mit Doxygen, zum Beispiel
/**
This does nothing
*/
-(void) doNothing
{
//This does nothing
}
und ich bekomme die erwarteten Ergebnisse in der HTML-Datei, die Doxygen generiert, aber ich weiß nicht, wie man diese Ergebnisse werden als Vorschläge in Xcode.
- Dokumentation in der auto-Vervollständigung popover vor XDACTED 5 ist hart codiert in die IDE, weil die KLAPPERN-5 war der erste, der die Einführung eines parser für das Zeug.
- Heißt das, dass ich kann nicht get popover Fertigstellung für benutzerdefinierte Methoden?
- Nope, nicht ohne einige ernsthafte hacking in IDEKit.
- Kann jetzt getan werden, mit Xcode 5. Siehe Antwort unten. Einer meiner fav neue Xcode 5 verfügt über
Du musst angemeldet sein, um einen Kommentar abzugeben.
Good news everyone! Xcode 5 hat jetzt eine integrierte Unterstützung für die DOxygen-Kommentare. So können Sie kommentieren Ihre Methoden wie diese:
Inline-Hilfe wird wie folgt Aussehen:
Schnelle Hilfe wird wie folgt Aussehen:
Und Hilfe in der Seitenleiste wird wie folgt Aussehen:
Hier ist eine praktische code-snippet, das Sie hinzufügen können, die Ihre Xcode-Code-Snippet-Bibliothek zu machen, Methode Dokumentation einfach:
Nun, Sie können geben Sie einfach "doxy" und Puff! Sie haben Ihre doxygen Vorlage.
<#...#>
Sache. Ich etwas neues lernen heute.Was ich gefunden habe, besser zu sein als ein code-snippet für Doxygen/Javadoc-Stil Kommentare ist mit VVDocumenter-Xcode-Plugin Es ist toll! Nach der Installation können Sie einfach eingeben: "///" über allen code, den Sie wollen kommentiert und es wird greifen die Parameter-und Rückgabe sowie fügen Sie Platzhalter für Ihren Kommentar-block.
War ich in der Lage zu erreichen, was ich wollte mit Appledocs, obwohl ich kämpfte ein wenig mit der installation und Einrichtung...
Öffnen Sie terminal und geben Sie
Wenn es fertig ist gehen Sie auf die appledoc-Ordner, geben Sie
installieren und appledoc in Ihrem usr/local/bin-Ordner mit diesem Befehl:
Öffnen xCode Projekt und gehen Sie auf den Paket-explorer auf der linken Seite, und klicken Sie auf Ihrem Haupt-Projekt-Datei (die, die Höhe der Ziele und der sdk-version, die unten beschrieben)
In der Build Registerkarte "Einstellungen", siehe unten bei '+Add Target " - Taste und öffnen Sie es
Wählen Sie das 'Aggregat' - Vorlage (stellen Sie sicher, wählen Sie iOS oder macosx abhängig von Ihrem Projekt und nennen Sie es 'Dokumentation'
Wählen Sie Dokumentation zu Erstellen Phasen-Registerkarte, und klicken unten auf 'Add Build Phase", und wählen Sie Add Run Script.
Kopieren und fügen Sie den folgenden code auf das Skript Ausführen " - Feld:
In der start-Konstanten, können Sie ersetzen Sie Namen und solche, auch stellen Sie sicher, dass das korrekte Ziel (iOS oder macosx)
Schließlich, gehen Sie zum Produkt - > Schema > Bearbeiten von Schema > Registerkarte "Erstellen" und fügen Sie Ihre 'Dokumentation' Ziel, stellen Sie sicher, dass alle Kontrollkästchen aktiviert ist. Auf diese Weise jedes mal, wenn Sie bauen Ihre code-Dokumentation aktualisiert wird.
... Und das ist es, Sie sind gut zu gehen und beginnen, dokumentieren Sie Ihren code.
Beachten Sie, dass obwohl die Dokumentation jedes mal aktualisiert, wenn Sie bauen, wird das popover Vorschläge nicht update erst nach einem Neustart von Xcode.
Für die ordnungsgemäße Dokumentation, Techniken, Lesen dieser Artikel