Question

只要通过键盘快捷键或Xcode编辑器生成文档，Xcode就不会生成returns文档。

生成的文档的示例：

/// <#Description#>
/// - Parameter message: <#message description#>
func greeting(message: String) -> String {
    return message
}

应该是：

/// <#Description#>
/// - Parameter message: <#message description#>
/// - Returns: <#.....#>
func greeting(message: String) -> String {
    return message
}

这是一个错误还是应该在某个地方更改设置？

Answer 1

这是一个错误。 Xcode的“添加文档”也完全忽略了throws。

例如，对于receives parameters，throws和returns的功能，这就是我得到的：

快捷方式：⌘ + ⌥ + /

/// <#Description#>
/// - Parameters:
///   - size: <#size description#>
///   - settings: <#settings description#>
func context(for size: CGSize, settings: SImageSettings = SImageSettings()) throws -> CGContext {
    // Function body.
}

预期：

/// <#Description#>
/// - Parameters:
///   - size: <#size description#>
///   - settings: <#settings description#>
/// - Throws: ????
/// - Returns: ????
func context(for size: CGSize, settings: SImageSettings = SImageSettings()) throws -> CGContext {
    // Function body.
}

我打开了a radar。另请通过Apple Feedback向其发布问题。 ??

Xcode 11：添加文档不包括退货

1 个答案: