Ios 如何使用 Swift 文档注释

发布于01月04日

关于SWIFT文档注释，我有几个问题:

有没有办法像某些Apple文档那样创建相关声明部分？例如，当我option+单击tablewView(_:heightForRowAtIndexPath:)方法时，它会将我链接到生成的文档中的其他三个相关方法.
SWIFT中是否有警告标签？我知道Objective-C允许我做@warning次，并在生成的文档中得到一个粗体警告.然而，在SWIFT的文档注释中，:warning:没有做任何事情，所以我很好奇是否有其他方法.
有没有办法将我的文档转换成与Apple文档格式类似的HTML文件？我知道在其他IDE中，比如Eclipse，我可以为我的代码生成HTML文档.XCode有这个吗？

推荐答案

This answer was last revised for Swift 5.2 and Xcode 11.4.个

您可以使用markup编写标准代码文档(使用///或/** */)和丰富的playground 文档(使用//:或/*: */).

/// This function returns a welcoming string for a given `subject`.
///
/// ```
/// print(hello("World")) // Hello, World!
/// ```
///
/// - Warning: The returned string is not localized.
/// - Parameter subject: The subject to be welcomed.
/// - Returns: A hello string to the `subject`.
func hello(_ subject: String) -> String {
    return "Hello, \(subject)!"
}