XCTest Document Project Generator
这是什么？
有时候，我们希望在 Xcode 的项目中生成测试目标的文档。
但是，Xcode 的文档生成功能或 Swift-DocC、jazzy 等文档生成工具只能针对 Xcode 上能直接运行的目标生成文档。
这个工具可以让上述工具生成包含在测试目标中的文件集文档。
基本思路
此工具会生成包含生成文档所需信息的无额外行为的 Swift 文件。
然后，使用其他工具对上述生成文件集进行文档生成。
安装
使用 Xcode 项目的 Swift Package Manager，将其作为依赖项注册。
let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/shotaIDE/xctest-document-project-generate", from: "0.1.0")
],
targets: [
// targets
]
)此外，还需要将另一个工具的 Swift-DocC 插件作为依赖项注册。
let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/shotaIDE/xctest-document-project-generate", from: "0.1.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0")
],
targets: [
// targets
]
)使用说明
请执行以下命令创建用于生成文档的项目。
swift run XCTestDocProjectGen path/to/your/test/swift/directory XCTestDocProject注意
目前，在 Swift Package Manager 中，不允许使用标准库以外的库来开发插件。本工具依赖于非标准的库，如 Swift Syntax 等，因此目前不支持作为插件使用。更多信息请参阅 https://github.com/apple/swift-package-manager/blob/main/Documentation/Plugins.md#implementing-the-command-plugin-script。
请执行以下命令生成文档。
cd XCTestDocProject
swift package generate-documentation关于文档生成的详细信息，请参阅 Swift-DocC Plugin 的文档。