在Xcode编写我们的quick help

程序环境 Xcode 13.2.1

“写代码要经常写注释。”虽然很多人不以为然,但是在使用Xcode的时候,我们在写注释的时候稍微注意一下格式的话,Xcode会给我们带来额外的正反馈,而所谓“正反馈”就是我们的注释会自动转换成帮助文档,显示在quick help上。
2022-02-26 16.58.43

简单的注释

///注释A
///
///hello world
- (void)functionA {
    
}

这里做注释要用三个斜杠/,而且每个部分之间要用空行间隔开来。
在这里看quick help,就会发现除了DeclarationDeclared In之外,还出现Summarydiscussion(不显示的同学记得cmd+s保存一下)

对参数的注释

我们定义的方法有很多时候是会带参数,如果我们要在注释里面对参数添加注释的话,只要新起一行将param + 参数名即可。

///注释A
///
///@param param1 参数1
///@param param2 参数2
///
/// hello world

这里有同学会好奇如果把中间的空行去掉会怎样,这就牵扯到一个问题:注释可能会出现长到不能完全在一行内显示,这个时候的做法是直接换到新的一行接着写

///注释A
///wewe
///
///@param param1 参数1
///@param param2 参数2Mr
///Yu4
///
///hello worldMM:
///SS

注释的参数

上一节我们用了@param这个参数来做注释,其实我们还可以还有许多参数来放进注释,而且我们将参数名写进去了之后,各个参数之间不需要空行隔开了

///@brief 注释A
///
///hello world
///@param param1 参数1
///@param param2 参数2
///@author MrYu4
///@warning 警告警告
///@version 1.0.0

另一种注释法

之前介绍的是三个/做的注释,其实还可以用另一种注释方法。

/**
 * @brief 注释A
 *
 * hello world
 * @param param1 参数1
 * @param param2 参数2
 * @author MrYu4
 * @warning 警告警告
 * @version 1.0.0
 */
posted @ 2022-02-27 19:57  MrYu4  阅读(218)  评论(0编辑  收藏  举报