Descrizione del metodo Objective-C (commenti del doc)

Question

Attualmente sto imparando Objective-C e ho bisogno di sapere come scrivere una descrizione del metodo. Sto avendo molte difficoltà a imparare come farlo in Objective-C.

In Jave abbiamo questa

/** 
<h2>MethodName</ h2 > 
<p>Various Description, can use html with images etc.</ p > 
*/ 
private void methodName(args[]..) 
{ 

} 

In Objective-C, dove devo posizionare la descrizione? Lo fa anche nel file di intestazione o nel file di implementazione?

//Within Implementation? 
- (float)gteHeightPercentage:(float)percentageToGet 
{ 
    return self.view.bounds.size.height * percentageToGet; 
} 

//Within Header? 
- (float)getWidthPercentage:(float)percentageToGet; 

Answer 1

Aggiornamento: il seguente formato funziona per Objc. Se si desidera documentare il codice rapido, fare riferimento a NSHipster's blog about Swift Documentation

XCode 5 può fare ciò che si desidera. Grazie alla Wonil Kim, nel file .h :

/** 
* Add new message between source to destination timeline as empty name string 
* @author Wonil Kim 
* 
* @param sourceId Source timeline entity ID 
* @param destId Destination timeline entity ID 
* @return A newly created message instance 
*/ 
- (ISMessage*)messageFromTimeline:(NSInteger)sourceId toTimeline:(NSInteger)destId; 

Una volta fatto questo, è possibile alt + clic sul nome del metodo, e .. voilà!

Naturalmente, come si può vedere su Kim's blog, questo non è l'unico modo:

/*! Some description of the method.... 
* \returns The result 
*/ 

In alternativa,

/// Some description to show up, done by: 
/// @author Olly Dixon 

Hai il punto ...

Come molti già detto, Objective-C non ti mostra la tua documentazione; infatti, nemmeno java (javadoc, potrebbe essere).È il tuo IDE, in questo caso, Xcode non abbattibile :)

UPDATE2:Complete list of "Special Commands" in comments.

Update3: Usa VVDocumenter-Xcode se si desidera attivare la generazione automatica di documentazione da parte ///.

Update4:: VVDocumenter è essere integrato per Xcode:

utilizzare la scorciatoia (⌥ Option + ⌘ Command + /) per aggiungere un commento documentazione al codice se si utilizza Xcode 8 o superiore a

Answer 2

Ciò che viene descritto è in breve "commenti alla documentazione" o "commenti del doc".

Xcode, a partire dalla versione 4.6.3, non visualizza i propri commenti del documento in una finestra pop-up o nella sua finestra di ispezione rapida. Devi compilare i tuoi commenti in un "docset" per ottenere Xcode per visualizzarli. Ci sono strumenti per farlo, ma non c'è modo di ottenere Xcode per ricaricare un docset tranne che chiudendolo e riavviandolo, quindi non consiglio di preoccuparmi.

Xcode 5 (che è attualmente disponibile come anteprima per sviluppatori per i membri a pagamento dei programmi di sviluppo OS X e iOS) fa visualizza i commenti del documento per il proprio codice; vedi “Quick Help” on the Developer Tools Features page. È necessario scrivere i commenti del doc nel file di intestazione. Puoi usare il formato doxygen o headerdoc.

Answer 3

In ogg-c dove posizionare la descrizione?

I compilatori Objective-C come gcc e llvm non si preoccupano di come si documenta il codice. Esistono diversi generatori di documentazione come Doxygen e HeaderDoc che possono creare documentazione da commenti formattati in modo appropriato, in genere nei file di intestazione. Inoltre, Xcode rende facile passare alla definizione dei simboli definiti nel codice, ed è un ispettore di "guida rapida" in grado di mostrarti le definizioni, entrambe senza annotazioni speciali nel codice.