分别记录解构赋值中的元素



在Swift中,你可以为一个单独的声明写一个文档注释,像这样:

/// The title of the view.
private var title: String

当你把光标放在title上时,Xcode会自动显示这个文档。您可以使用Markdown和一些特定于swift的语义格式,如这篇NSHipster文章所述。

是否有可能单独记录像这样的解构赋值所产生的变量?

private var (titlePromise, titleSeal) = Promise<String>.pending()

我尝试了我认为是显而易见的事情,

private var (
/// Promise that will resolve when we receive the view's title.
titlePromise,
/// Resolver function for the view's title.
titleSeal
) = Promise<String>.pending()

但是Xcode并没有注意到这些注释。我发现可以在两者之前加上一个文档注释

/// Promise and resolver for the view's title.
private var (titlePromise, titleSeal) = Promise<String>.pending()
在这种情况下,Xcode将该文档应用于promiseseal。这是不理想的,因为这些变量(虽然相关)是不同的类型,具有不同的用途。

是否有可能单独记录两个(或全部)元素在一个元组赋值的方式,Xcode将拾取?

即使我有同样的需求,但我没有找到任何这样的解决方案。虽然apple提供了丰富的文档,并帮助编写不同类型的代码注释,但到目前为止,还没有办法为元组属性编写文档注释。但是,我也遇到了这样的文字。

/// A tupple property whcih holds the values of title
/// - Parameters:
///     - titlePromise: So on so.....
///     - titleSeal: So on so.....
/// ```
/// mTitle = Promise<String>.pending()
/// print(mTitle.titlePromise)
/// ```
var mTitle: (titlePromise: String, titleSeal: String)?

相关内容

  • 没有找到相关文章

最新更新