如何在 XCode 中的结构中记录结构（Swift 或 Obj-C）

Question

我们都知道，在记录结构时，可以使用@struct 来表示结构，并使用@field 来解释结构中的内容。

但是如何用另一个结构中的某些字段记录一个结构？

在 Swift 中，示例代码为：

struct Constants{
    static let kButtonHeight : CGFloat = 0
    struct Color {
      static let kCloud: UIColor = UIColor(red: 236/255, green: 240/255, blue: 241/255, alpha: 1.0)
    }
}

非常感谢！

Answer 1

我会在常量的定义之外（和 before/above）定义 Color 结构，然后常量的定义将有一个 Color 类型的成员，但没有 'nested' 定义。如果您考虑 CGRect，这是一个 'struct of structs'（一个 CGPoint 和一个 CGSize），但这些成员结构也可以单独使用。

Answer 2

如果您在 Swift 中执行此操作，您可以在任何内容（类型、属性或实例等）前加上 single-line 标记为 [=11] 的注释=] 或 multi-line 以 /** 开头的评论。所以你的文档可以简单地是：

/// A global container for all constants
struct Constants{
    /// The default button height
    static let kButtonHeight : CGFloat = 0

    /// Constant UIColor instances for my app
    struct Color {
        /// The cloud color - a very pale blue-white
        static let kCloud: UIColor = UIColor(red: 236/255, green: 240/255, blue: 241/255, alpha: 1.0)
    }
}

文档随即附上 -- 选择点击名称即可获得相关文档：

如何在 XCode 中的结构中记录结构（Swift 或 Obj-C）

How to document a struct within a struct in XCode (Swift or Obj-C)

xcode

struct

objective-c

swift