objective-c - 如何在 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

如果您在 Swift 中执行此操作，您可以在任何内容(类型、属性或实例等)前添加以 /// 标记的单行注释或多行注释以 /** 开头。所以你的文档可以简单地是:

/// 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)
    }
}

文档随即附上——选项单击一个名称，您将获得相关文档: