Xcode代碼文檔

Question

有關如何記錄用XCode編寫的代碼的指南/標准嗎？ 我的意思是，有沒有辦法記錄代碼，如果你想讓其他人容易理解？ XCode是否提供了一種工具，可用於從代碼+注釋中自動生成類似API參考文檔的文檔？

至少我有興趣了解在代碼中定義的接口/協議/方法之前是否存在編寫注釋的標准方法。 我見過使用類似下面的指令，但我不明白它們是如何工作的：

#pragma mark -
#pragma mark Initialization

Answer 1

您可以將這兩行合並為一個： #pragma mark - Initialization 。 單擊方法列表（向上，向右），您將看到帶有一行的粗體標題。 它只是分組中方法分組的標記。

以上Derek發布的編碼指南鏈接必讀。

如果你想生產類似蘋果的文檔，你必須使用這個優秀的免費第三方工具： http ： //www.gentlebytes.com/appledoc/ Apple沒有為你提供任何接近的東西。

---

Pragma是一種ISO C功能，用於將提示傳遞給編譯器。

XCode（AFAIK）中唯一的pragma添加mark為-和/或文本。 這會在方法查找器中創建一行和/或粗體文本。

// Mark a section in your code with a line and a bold text.
// You can use the line or the text alone.
#pragma mark - random text

如果您正在編輯不使用GCC編譯的語言的文件，您仍然可以在注釋上使用標記（這也適用於GCC語言）：

// MARK: - random text
/* MARK: more random text */

但我使用#pragma mark，因為我的顏色主題有紅色的pragma，它們比評論更突出。 如果您想將pragma代碼段綁定到熱鍵，請使用

#pragma mark - <#Description#>

所以你可以跳轉到描述文字。

關於pragma的更多信息：

• 什么是pragma？
• 6.56海灣合作委員會接受的語用學
• Clang 通過Pragma控制診斷
• 函數屬性優先於編譯指示，因為您無法從宏生成編譯指示，並且編譯指示可能在另一個編譯器上具有不同的含義。

Answer 2

添加到@ jano的答案，使用以下格式來描述您的方法的功能。

  /*!
 @function       getEmployeeDetails
 @abstract       getEmployeeDetails
 @discussion     This function will fetch employee details based on employee id
 @param          strEmpId 
 employee unique id
 @result         an Array of Employee
 */

-(NSArray*)getEmployeeDetails:(NSString *)strEmpId{
     /*Do somethings.*/
}