2012-09-24 92 views
5

我發現記錄我的界面特別痛苦,因爲我需要自己輸入所有內容。所以我想我不應該是這樣的唯一一個,並開始尋找一種方法來減輕我的痛苦,但沒有發現太多。Xcode評論自動完成(appledoc風格)

我的問題是,是否有快捷方式或讓Xcode自動完成我的評論?舉例來說,我很願意,如果我鍵入/** + [tab],它自動填充到:

/** 
* [cursor here] 
* 
* (maybe some pre-populate a list of arguments for the method below) 
*/ 
- (void)test:(NSString *)testString another:(NSString *)another; 

謝謝!

回答

10

使用Xcode的片段功能。你可以用你想要的任何文本創建一個片段,然後在要填寫的文本中添加項目。要創建一個片段,只需在Xcode編輯器中選擇一些文本並將其拖入片段庫。您可以設置完成快捷方式,所以像m-comment可能是你的標準方法的評論:

snippet editor

打字m-comment第一位則顯示整個快捷方式(以及任何其他的完成),並接受完成增加與參數化部分等待評論中充滿像往常一樣,你可以使用Tab鍵從一個到下一個:

inserted comment

您表示文本的特定部分將被填滿我的字段n通過將其包含在<##>中,如:<#method name#>

當然,Objective-C的優勢之一是方法名稱通常會告訴你參數是什麼。在評論中重複這一點似乎是不必要的額外工作。 Xcode 3更好地支持包含腳本的腳本,這些腳本可以自動生成帶有參數的HeaderDoc註釋。但是,它們並沒有被廣泛使用,可能是因爲這些評論並沒有真正有用。

+1

我的上帝,爲什麼我沒有想到...謝謝迦勒! – xidew

+1

@xidew片段可能是Xcode最不受歡迎的酷炫功能。我們大多數人仍然沒有學會充分利用它。 – Caleb

+0

@Caleb不好意思打擾了,但是我怎麼才能使它成爲XCode 4.3?因爲該代碼段不在我的XCode中,我無法運行它手工製作,'<#method#>':( – rokimoki