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,相信其他非开发此物件的成员就可以快速的查询,就不需要一边翻说明文件一边操作。