complemento automatico commenti Xcode (stile appledoc)

Question

Trovo particolarmente doloroso documentare le mie interfacce perché è necessario digitare tutto da solo. Così ho pensato che non dovevo essere l'unico in questo modo e ho iniziato a cercare un modo per ridurre il mio dolore ma non ho trovato molto.

La mia domanda è, c'è una scorciatoia o un modo per fare in modo che Xcode completi automaticamente i miei commenti? Ad esempio, mi piacerebbe molto come se di tipo I /** + [tab] che autocompletes a:

/** 
* [cursor here] 
* 
* (maybe some pre-populate a list of arguments for the method below) 
*/ 
- (void)test:(NSString *)testString another:(NSString *)another; 

Grazie!

Answer 1

Utilizzare la funzione snippet di Xcode. Puoi creare uno snippet con qualsiasi testo tu voglia e aggiungere elementi nel testo da compilare. Per creare uno snippet, basta selezionare un testo in un editor Xcode e trascinarlo nella libreria snippet. È possibile impostare il collegamento di completamento, in modo da qualcosa come m-comment potrebbe essere il vostro metodo standard commento:

Digitando il primo bit di m-comment quindi visualizza l'intero collegamento (e qualsiasi altro completamenti), e accettando il completamento aggiunge un commento con le parti parametrizzate in attesa di essere riempito in Come al solito, è possibile scheda da uno all'altro:.

si indica che una determinata parte del testo è un campo da riempire i n racchiudendolo in <# e #>, ad esempio: <#method name#>.

Ovviamente, uno dei punti di forza di Objective-C è che il nome del metodo generalmente indica quali sono i parametri. Ripetendolo in un commento sembra un inutile lavoro extra. Xcode 3 ha un supporto migliore per script inclusi script che generano automaticamente commenti HeaderDoc con parametri. Non erano molto usati, però, probabilmente perché quei tipi di commenti non erano davvero utili.