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

时间:2018-03-13 18:38:12

标签: 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的文档中找到这个技巧,或者我错过了什么?

1 个答案:

答案 0 :(得分:1)

无法直接引用函数文档中的参数标签

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

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

使用反向标记,它与参数本身很好地融合在一起:

example function documentation