方法“文件”

Objective-C没有内置的文档功能。苹果包括一个叫做headerDoc的工具,可以从源文件生成文档,但是 several better options . 我觉得最受欢迎的是 Doxygen 在这种情况下,语法是Java风格。 /** Documentation here */ . 您可以查看 Wikipedia page 例如如何使用它(尽管与其他语言一起使用)。苹果有 instructions for using Doxygen with Xcode 在它的网站上。

Xcode5中有一种新的功能来记录您的方法。在头文件中,您可以像这样向函数添加注释,以便在文档中显示这些注释:

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

注意第一行的感叹号。

此文档将显示在xcode右侧窗格的快速帮助中,键入时,描述将显示在函数自动完成中。