Méthode 'documentation'

Question

Quelle est la syntaxe objective-c pour documenter l'utilisation d'une méthode? Est-ce fait dans le fichier .h ou .m?

En C# on utilise quelque chose comme:

/// <summary> 
/// Executes an HTTP GET command and retrieves the information.  
/// </summary> 
/// <param name="url">The URL to perform the GET operation</param> 
/// <param name="userName">The username to use with the request</param> 
/// <param name="password">The password to use with the request</param> 
/// <returns>The response of the request, or null if we got 404 or nothing.</returns> 
protected string ExecuteGetCommand(string url, string userName, string password) { 
... 
} 

Est-ce fait avec la directive #pragma?

Merci,

Craig Buchanan

Answer 1

Objective-C ne dispose pas d'une fonction de documentation intégrée. Apple inclut un outil appelé Headerdoc qui peut générer des documents à partir de fichiers sources, mais il existe several better options. Je pense que le plus populaire est Doxygen, auquel cas la syntaxe est le /** Documentation here */ de style Java. Vous pouvez consulter le Wikipedia page pour des exemples de la façon dont il est utilisé (mais avec d'autres langues). Apple a instructions for using Doxygen with Xcode sur son site.

Answer 2

Il existe une nouvelle fonctionnalité dans Xcode 5 pour documenter vos méthodes. Dans votre fichier d'en-tête, vous pouvez ajouter des commentaires à votre fonction comme tant pour les faire apparaître dans la documentation:

/*! Executes an HTTP GET command and retrieves the information. 
* \param url The URL to perform the GET operation 
* \param userName The username to use with the request 
* \param password The password to use with the request 
* \returns The response of the request, or null if we got 404 or nothing 
*/ 
- (NSString *)executeGetCommandWithURL:(NSURL *)url userName:(NSString *)aUserName andPassword:(NSString *)aPassword; 

Notez le point d'exclamation sur la première ligne.

Cette documentation s'affichera dans l'aide rapide dans le volet droit de Xcode, et la description s'affichera dans la fonction d'auto-complétion lorsque vous tapez.