在實現文件

Question

簡化文檔記錄我在我的接口文件中的方法是這樣的：

/** 
Returns an foo object containing a new bar value. 

@param newBar The bar value for the new foo. (Possible values: foo or bar) 

@return A foo object containing a calculated value. 

You can specify bar values in the following formats `bar`, `foo`. 

*/ 

Xcode中生成一個不錯的彈出時，我即點擊與ALT的方法名。

爲了實現這個我私人的方法，我在我的.m文件的頂部添加了一個@interface。在這裏我宣佈並記錄我的方法。然而，a）將我的文檔與方法的實際實現分離開來，b）在快速跳轉菜單（代碼窗格上方）中，由於我所有記錄的方法都出現了兩次（一次是從斜體的@interface一次以及一次來自@implementation）。

有沒有更好的方法來做到這一點？如果我在@implementation中記錄方法Xcode似乎不會生成彈出信息。

Answer 1

如果您的班級是TheInterface，則可以使用額外的標頭，它可以是TheInferface-Private.h。

定義並記錄您在這個新標題上的私有方法和屬性。文檔按預期工作，您將在跳轉欄中看到雜亂無章的內容。

它不能解決與執行問題分離的文檔。我不明白爲什麼這是一個問題，每個人都希望在一個頭文件中的文檔。

在一個單獨的頭文件中有一些私有方法在hackish子類中有時很方便。