Xcode 5 新增功能:QucikHelp替Method加註解

Xcode 4.x之前,使用內建的framework時,如果想要查詢method的使用方式除了看官網的Help之外,只要按下option (alt) 鍵,鼠標會轉換成”?”問號方式提供查詢,點下你要查詢的method它就會快速的跳出資訊來顯示說明,

這麼方便的方式,是否可以用在自訂的Method上面呢?Xcode 5開始,Xcode已經正式支援這個功能,自訂完成後就能看到下圖:

可以直接對自訂物件公開的Method撰寫一些說明,整個完整度跟官方內建的是沒什麼差別,也增加自訂物件的可讀性與使用性。

以下是以我自訂Bluetooth 4.0 Low Energy連接方式的Object,這個Object新增了許多方便的Method,剛好可以增加一些QuickHelp功能,讓其他使用的工程師能快速的查詢,如果要呈現這樣的效果就要像下面的做法:

註解說明一定要寫在method前面,並照上面的格式去填寫,

  • 第一行

“!”驚嘆號後的內容為Description

  • 第二行

”\param”之後接的是你的參數說明,依照您有幾個參數就可以依照數量增加,這個例子只有1個參數,所以只有一組”\param”

  • 第三行

最後”\returns”為針對返回參數做說明。

這個方式也可以另外對自已建立的或是內建的Object做說明,下面的例子就是我自建的DYCoreBluetooth在查詢時,顯示的說明

整個完成後,當你在其他專案引用物件時,就可以查詢到這個物件的說明:

對於多人協同合作的專案來說,如果有非常多的自建物件需要建立,那麼成員遵照這個方式將建物件都加上QuickHelp,相信其他非開發此物件的成員就可以快速的查詢,就不需要一邊翻說明文件一邊操作。