ios注释的正确写法

来源:互联网 发布:知乎 筑基 编辑:程序博客网 时间:2024/04/28 10:25

假如自己写了一个ios库,如何做到像系统库那样,在Xcode的Quick help里有注释说明呢?如下图那样


其实很简单,只要按照固定格式在头文件里写注释就可以了,其格式也是编程通用注释格式。

如上图格式,写好描述,参数@param,返回值@return。就可以在Xcode的Quick help里显示出来了。

另外:

你可能觉得这么写注释很麻烦,其实有插件支持这种注释写法的,只要连按三个"/",插件就会自动把注释框架写好,自己填内容就可以了。

0 0
原创粉丝点击