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

Question

Ich bin mir bewusst, dass Doxygen die Dokumentation erstellt. Was ich suche, ist ein schneller Weg, eine Dokumentation in Xcode einzufügen, ähnlich wie Eclipse beim Bearbeiten von Java-Dateien.

Sagen wir, ich habe eine Objective-C-Methode mit ein paar Argumente wie folgt aus:

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

in Eclipse, wenn Sie den Cursor über das Verfahren und die Art setzen: /**<Enter> Sie Javadoc Vorlage prä- erhalten bestückt mit @param und @return Tags.

Ist es möglich, etwas ähnliches in Xcode zu erreichen? Nach der Eingabe /**<Enter>, würde ich dies gerne automatisch erhalten:

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

Answer 1

Wenn Sie die Geduld haben, werfen Sie einen Blick here wie es Fertigstellung Verhalten und Überschreibungen in XCode erklärt. Ich weiß nicht, ob das für den Kommentar funktioniert, aber es scheint ein guter Anfang zu sein.

- Frank

Answer 2

Das "User Scripts" Menü (das kleine schwarze Scroll-Symbol in der Menüleiste Xcode) eine HeaderDoc Untermenü mit Vorlagen für alle Arten von Dokumentation Markup in HD-Syntax. Sie können eine Tastenkombination für die Elemente festlegen, die Sie verwenden möchten, indem Sie im Xcode-Fenster "Einstellungen" zu "Tastenkombinationen" gehen.

Da Benutzerskripts im Grunde Shellskripte sind, können Sie jede Skriptsprache verwenden, um Ihre eigenen zu schreiben. Wenn Sie möchten, könnten Sie sogar ein kleines regex-unterstütztes Skript schreiben, das die Parameternamen aus der ausgewählten Zeile ausfüllt und ausfüllt die Grundlagen Ihres HeaderDoc-Kommentars.

Answer 3

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 Script: https://github.com/premosystems/DoxygenXCodeHelper

Answer 4

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