用于编码和解码 Swift 符号图文件的 Swift 包

符号套件

符号图形文件格式的规范和参考模型。

符号图将模块(在各种编程语言中也称为“框架”、“库”或“包”)建模为有向图。在此图中,节点是声明,连接节点的边是声明之间的关系。

通过对不同类型的关系进行建模,SymbolKit 可以为文档提供丰富的数据,回答有趣的问题,例如:

  • 哪些类型符合此协议?
  • 植根于这个类的类层次结构是什么?
  • 哪个协议提供称为计数的要求?
  • 哪些类型自定义此协议要求?

此外,数据的图形表示也为文档中的可视化提供了机会,说明了模块的结构或层次结构。

有关该库的更多详细信息,请参阅 SymbolKit 的文档站点

开始使用 SymbolKit

在 Swift 包管理器清单中,将以下依赖项添加到参数中:Package.swiftdependencies

.package(url: "https://github.com/apple/swift-docc-symbolkit.git", .branch("main")),

将依赖项添加到清单中声明的任何目标:

.target(name: "MyTarget", dependencies: ["SymbolKit"]),

GitHub

查看 Github