Swift DocC

Swift-DocC插件是一个Swift软件包管理器命令插件，支持为SwiftPM库和可执行文件构建文档。

⚠️ 注意：运行 Swift-DocC 插件需要 Swift 5.6 及以上版本

依赖 DocC 插件

 1// Package.swift
 2let package = Package(
 3    //...
 4    dependencies: [
 5       .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.3.0"),
 6    ],
 7    targets: [
 8       .target(
 9            name: "MyProject",
10            dependencies: ["SwiftDocCPlugin"]),
11    ]
12)

编译 Swift 项目

1swift build

生成文档

1# 生成文档到./docs 目录
2swift package --allow-writing-to-directory ./docs \
3    generate-documentation --target ProjectName --output-path ./docs

预览文档

1# 预览文档, 注释内容改变后需要重新执行预览文档命令
2swift package --disable-sandbox preview-documentation --target ProjectName