方法'文檔'

Question

記錄方法使用情況的objective-c語法是什麼？這是在.h或.m文件中完成的嗎？

在C＃一個使用類似：

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

這是與#pragma指令做了什麼？

感謝，

克雷格·布坎南

Answer 1

的Objective-C沒有內置的文檔功能。 Apple包含一個名爲Headerdoc的工具，可以從源文件生成文檔，但有several better options。我認爲最流行的是Doxygen，在這種情況下，語法是Java風格/** Documentation here */。您可以查看Wikipedia page以瞭解它如何使用（儘管有其他語言）。 Apple在其網站上有instructions for using Doxygen with Xcode。

Answer 2

Xcode 5中有一項新功能可以記錄您的方法。在第一行

/*! 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右窗格的快速幫助中，當您鍵入時，說明會在功能自動完成中顯示。