Methode 'Dokumentation'

Question

Wie lautet die objektive Syntax für die Dokumentation der Verwendung einer Methode? Ist das in der .h oder .m Datei gemacht?

In C# verwendet man so etwas wie:

/// <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) { 
... 
} 

Ist das mit der Pragma Direktive getan?

Danke,

Craig Buchanan

Answer 1

Objective-C hat keine Dokumentation Feature eingebaut. Apple enthält ein Tool namens Headerdoc, mit dem Dokumente aus Quelldateien generiert werden können. Es gibt jedoch several better options. Ich denke, am beliebtesten ist Doxygen, in diesem Fall ist die Syntax der Java-style /** Documentation here */. Sie können die Wikipedia page für Beispiele wie es benutzt wird (wenn auch mit anderen Sprachen). Apple hat instructions for using Doxygen with Xcode auf seiner Website.

Answer 2

Es gibt eine neue Fähigkeit in Xcode 5, um Ihre Methoden zu dokumentieren. In Ihrer Header-Datei können Sie einen Kommentar zu Ihrer Funktion hinzufügen, wie so, um sie in der Dokumentation zu machen zeigen:

/*! 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; 

Hinweis das Ausrufezeichen in der ersten Zeile.

Diese Dokumentation wird in der Schnellhilfe im rechten Bereich von Xcode angezeigt, und die Beschreibung wird bei der automatischen Vervollständigung der Funktion bei der Eingabe angezeigt.