Esiste un plug-in per Javadoc per Xcode che genera automaticamente il modello di documento?

Question

Sono a conoscenza di Doxygen per generare la documentazione. Quello che sto cercando è un modo rapido per inserire la documentazione in Xcode simile a ciò che fa Eclipse quando si modificano i file Java.

Diciamo che ho un metodo di Objective-C con un paio di argomenti come questo:

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

In Eclipse, se si posiziona il cursore sopra il metodo e il tipo: /**<Enter> si ottiene un modello di Javadoc pre- popolato con tag @param e @return.

È possibile ottenere qualcosa di simile in Xcode? Dopo aver digitato /**<Enter>, mi piacerebbe ottenere questo automaticamente:

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

Answer 1

Se avete la pazienza, un'occhiata here come si spiega il comportamento di completamento e le sostituzioni in XCode. Non so se questo funzionerà per il set di commenti, ma sembra un buon inizio.

- Frank

Answer 2

Il menu "User Scripts" (quella piccola icona di scorrimento nera nella barra dei menu di Xcode) ha un sottomenu HeaderDoc con modelli per tutti i tipi di documentazione di markup nella sintassi HD. Puoi impostare una scorciatoia da tastiera per gli elementi che desideri utilizzare andando in "Key Bindings" nella finestra "Preferences" di Xcode.

Poiché gli script utente sono essenzialmente script di shell, è possibile utilizzare qualsiasi linguaggio di scripting per scrivere il proprio, quindi se si desidera si potrebbe anche scrivere un piccolo script regex che analizza i nomi dei parametri fuori dalla riga selezionata e si compila le basi del tuo commento HeaderDoc.

Answer 3

Lo script qui http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/ fa esattamente ciò che si desidera.

EDIT: Ecco una versione aggiornata dello script: https://github.com/premosystems/DoxygenXCodeHelper

Answer 4

ho utilizzato con successo in Xcode VVDocumenter-Xcode 5 e funziona bene. Genera automaticamente un modello specifico per un metodo quando si inserisce "///" sopra il metodo.