代码之家 › 专栏 › 技术社区 › Jean-Baptiste Yunès

如何在XCode中记录Swift函数的参数标签和非参数名称?

documentation markdown xcode swift

Jean-Baptiste Yunès · 技术社区 · 7 年前

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

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

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

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

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

注意:我在苹果的文档中找不到诀窍,或者我错过了什么?

1 回复 | 直到 7 年前

glyvox 7 年前

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

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

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

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

推荐文章

Safa Ads · CDN:无法下载中继URL:https://cdn.jsdelivr.net/cocoa/Specs/2/e/c/RxSwift/3.0.0-rc.1/RxSwift.podspec.json响应:SSL连接错误

1 年前

sizzyd · XCode IOS如何摆脱主屏幕上的后退按钮?

2 年前

Lokesh Rahul · 如何在向上滚动时向上滚动和导航栏,以及在向下滚动时需要显示的内容

2 年前

xdavidliu · XCode项目对C++标准的选择没有得到尊重

2 年前

Ali · UiView()内的自定义匿名闭包导航返回按钮

2 年前

user3907 · Xcode问题-崩溃-无法从文件中读取属性列表

2 年前

LucasMaliszewski · XCODE:Thread 1:EXC_BAD_访问(代码=1,地址=0x68)在fscanf上

2 年前

Joshua Maza · 其他人有没有办法配置我的cocoapod或swift软件包库中使用的常量?

2 年前

Vinod prajapat · 如何更新数组的最后一个元素?

2 年前

treesarecool · SwiftUI:如何设置颜色。foregroundColor()是否使用字符串?i、 e.“绿色”-->颜色。绿色

2 年前