swift - 如何在 XCode 中记录参数标签而不是 Swift 函数的参数名称?

标签 swift xcode markdown documentation

我知道如何记录函数的参数名称,例如:

/**
 - parameters:
   - param: the parameter
 */
func myFunc(param: Int) {...}

但我无法记录参数标签(有或没有参数名称):

/**
 - parameters:
   - label: the label
   - param: the parameter
 */
func myFunc(label param: Int) {...}

毕竟,记录标签比参数名称更重要,因为它是在函数调用时使用的。

注意:我一直无法在 Apple 的文档中找到技巧,还是我遗漏了什么?

最佳答案

不能直接引用函数文档中的参数标签

作为解决方法,您可以在参数说明中提及标签,如下所示:

/**
 - parameters:
     - param: (argument label: `label`) the parameter
 */
func myFunc(label param: Int) {...}

通过使用反引号,它与参数本身很好地融合在一起:

example function documentation

关于swift - 如何在 XCode 中记录参数标签而不是 Swift 函数的参数名称?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/49263549/

相关文章:

ios - swift 火力地堡 : Update specific objects resulting from Firebase query

ios - 如何添加自定义tableviewcell分隔符?

xcode - 从 Xcode 的控制台打印 (po) Swift 匿名闭包参数的值

python - 将 Mkdocs 部署到 Azure Web 应用

css - 带有 HiDPI/Retina 图像的 Markdown

javascript - 如何动态加载markdown文件到vue中?

swift - xcode Swift 3中&lt;iframe&gt; </iframe>中视频顶部和左侧的多余空间

Xcode 6.3 解析 SDK 1.7.1 PFTableViewCell 错误 "has incompatible type"

xcode - 如何增加图像的尺寸?

swift - 为什么 type(of : object) == ClassName. self 会返回错误的结果?