如何用Result注释完成处理程序?

时间:2019-07-11 12:06:48

标签: swift annotations completionhandler swift5

我有以下带有示例注释的示例方法。

    /// Notes to explain what example function does
    ///
    /// - Parameters:
    ///     - foo: description of foo property
    ///     - bar: description of bar property
    ///     - completion: description of completion
    ///
    func exampleFunction(foo:String, bar:String, completion:@escaping
    (Result<(Bool), Error>) -> Void) {

        //Code with completion

    }

但是,如果我按住alt并单击该方法,则会显示以下内容。

screen shot of documentation for method

我在完成处理程序下出现“没有描述”。如何正确地为完成处理程序和迅速的5 Result类型添加注释,以便看不到“无描述”,并且可以添加我想要的文本?

0 个答案:

没有答案