Symbol Graph 文件格式的规范和参考模型。
Symbol Graph 将一个模块(在各种编程语言中也称为“框架”、“库”或“包”)建模为一个 有向图。在这个图中,节点是声明,连接节点的边是声明之间的关系。
通过对不同类型的关系进行建模,SymbolKit 可以提供丰富的数据来支持文档,回答有趣的问题,例如:
count
的要求?此外,数据的图形表示也为文档中的可视化提供了机会,从而可以展示模块的结构或层次结构。
请访问 SymbolKit 的 文档站点,以获取有关该库的更多详细信息。
在您的 Package.swift
Swift Package Manager 清单文件中,将以下依赖项添加到您的 dependencies
参数中
.package(url: "https://github.com/apple/swift-docc-symbolkit.git", .branch("main")),
将依赖项添加到您在清单文件中声明的任何目标中
.target(name: "MyTarget", dependencies: ["SymbolKit"]),
欢迎并鼓励向 SymbolKit 贡献代码!请参阅《贡献 Swift 指南》。
在提交拉取请求之前,请确保您已测试您的更改,并且它们符合 Swift 项目的代码贡献指南。
为了成为一个真正伟大的社区,Swift.org 需要欢迎来自各行各业、不同背景和具有广泛经验的开发者。一个多元化且友好的社区将拥有更多伟大的想法、更独特的视角,并产出更出色的代码。我们将努力使 Swift 社区对所有人表示欢迎。
为了明确对我们成员的期望,Swift 采用了 Contributor Covenant 定义的行为准则。这份文档在许多开源社区中使用,我们认为它很好地表达了我们的价值观。有关更多信息,请参阅《行为准则》。