在Xcode编写我们的quick help
程序环境 Xcode 13.2.1
“写代码要经常写注释。”虽然很多人不以为然,但是在使用Xcode的时候,我们在写注释的时候稍微注意一下格式的话,Xcode会给我们带来额外的正反馈,而所谓“正反馈”就是我们的注释会自动转换成帮助文档,显示在quick help上。
简单的注释
///注释A /// ///hello world - (void)functionA { }
这里做注释要用三个斜杠/
,而且每个部分之间要用空行间隔开来。
在这里看quick help,就会发现除了Declaration
、Declared In
之外,还出现Summary
、discussion
(不显示的同学记得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 */
本文来自博客园,作者:MrYu4,转载请注明原文链接:https://www.cnblogs.com/MrYU4/p/zaixcode-bian-xie-wo-men-dequick-help.html
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· 上周热点回顾(2.17-2.23)