DefaultStringConvertible

Swift类型的一个默认CustomStringConvertible实现

关于

再也不用实现var description: String了。只需简单地import DefaultStringConvertible并遵从CustomStringConvertible，就可以免费获得类型默认描述。

这个微库基于Erica Sadun的这篇博客：http://ericasadun.com/2016/04/18/default-reflection/

要求

• Swift 3
• Xcode 8
• iOS 8.0+
• macOS 10.10+
• tvOS 9.0+
• watchOS 2.0+
• Ubuntu 14.04+

安装

Swift 包管理器

将DefaultStringConvertible作为依赖项添加到您的Package.swift中。例如：

let package = Package(
    name: "YourPackageName",
    dependencies: [
        .Package(url: "https://github.com/jessesquires/DefaultStringConvertible.git", majorVersion: 2)
    ]
)

文档

阅读文档。由jazzy生成。由GitHub Pages托管。

生成

$ ./build_docs.sh

预览

$ open index.html -a Safari

入门

import DefaultStringConvertible

class MyClass: CustomStringConvertible {
    // ...

    // You *do not* need to implement `var description: String`
    // by importing `DefaultStringConvertible`, you get a default `description` for free
}

单元测试

有一组单元测试针对DefaultStringConvertible。通过在Xcode中打开DefaultStringConvertible.xcodeproj来运行它们。

贡献

请遵循这些简单的贡献指南。

鸣谢

由@jesse_squires创建和维护。

许可证

DefaultStringConvertible根据MIT许可证发布。有关详细信息，请参阅LICENSE。

版权所有 © 2016-至今 Jesse Squires。

请提供归属，我们将非常感激。