Gibt es ein Javadoc-ähnliches Plugin für Xcode, das automatisch die Dokumentvorlage generiert?

Question

Ich kenne Doxygen, um die Dokumentation zu erstellen. Was ich suche, ist eine schnelle Möglichkeit, Dokumentation in Xcode einfügen, ähnlich wie Eclipse tut, wenn Java-Dateien zu bearbeiten.

Nehmen wir an, ich habe eine Objective-C-Methode mit ein paar Argumenten wie diesem:

-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

Wenn Sie in Eclipse den Cursor über der Methode platzieren und eintippen: /**<Enter> erhalten Sie eine Javadoc-Vorlage, die bereits mit @param y @return Tags.

Ist es möglich, etwas Ähnliches in Xcode zu erreichen? Nach der Eingabe von /**<Enter> Ich möchte, dass dies automatisch geschieht:

/**
 *
 * @param one
 * @param two
 * 
 * @return
 */
 -(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

Answer 1

Das Skript hier http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/ macht genau das, was Sie wollen.

EDIT : Hier ist eine aktualisierte Version des Skripts: https://github.com/premosystems/DoxygenXCodeHelper

Answer 2

Ich habe mit VVDocumenter-Xcode erfolgreich in Xcode 5 und es funktioniert gut. Es generiert automatisch eine Vorlage spezifisch für eine Methode, wenn Sie "///" über die Methode eingeben.

Answer 3

Das Menü "User Scripts" (das kleine schwarze Scroll-Symbol in der Menüleiste von Xcode) enthält ein Untermenü "HeaderDoc" mit Vorlagen für alle Arten von Dokumentationsauszeichnungen in HD-Syntax. Sie können ein Tastaturkürzel für die Elemente, die Sie verwenden möchten, indem Sie auf "Key Bindings" in Xcode "Preferences" Fenster.

Da Benutzerskripte im Wesentlichen Shell-Skripte sind, können Sie jede beliebige Skriptsprache verwenden, um Ihre eigenen Skripte zu schreiben. Wenn Sie möchten, können Sie sogar ein kleines Regex-gestütztes Skript schreiben, das die Parameternamen aus der ausgewählten Zeile analysiert und die Grundlagen Ihres HeaderDoc-Kommentars ausfüllt.

Answer 4

Wenn Sie die nötige Geduld haben, sehen Sie sich das an aquí da es das Abschlussverhalten und die Überschreibungen in XCode erklärt. Ich weiß nicht, ob dies für den Kommentarsatz funktionieren wird, aber es scheint ein guter Anfang zu sein.

-- Frank