关于 generating-swift-package-docs
按需为 Swift 包依赖生成 API 文档的工具。它通过 `interfazzle` 从 Xcode DerivedData 提取符号信息,帮助开发者了解陌生模块。
主要功能
- 01按需生成 API 文档
- 02从编译模块提取符号
- 03缓存文档输出
适用场景
- 01了解陌生的 Swift 依赖
- 02解答关于包 API 的问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ johnrogers/ claude-swift-engineering --skill generating-swift-package-docs安装后在 Claude Code 中输入/generating-swift-package-docs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
reference.mdscripts/generate_docs.pyswift_packages.py详细介绍
Swift Package 文档生成器
按需为 Swift 包依赖生成 API 文档,从 Xcode 的 DerivedData 中提取符号信息,以回答“这个库有什么作用?”
概述
探索不熟悉的依赖时,可以自动生成其文档,而不是对着代码猜测。此工具使用 interfazzle 从已编译的模块中提取符号信息。
使用方法
有人询问不熟悉的 Swift 模块导入时:
- 运行:
./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>" - 脚本会输出缓存文档文件的路径
- 阅读该文件并提供相关信息
前提条件:项目必须至少构建过一次(存在 DerivedData),并且已安装 interfazzle CLI。
错误处理和详细信息请参阅 reference.md。
评论
支持 Markdown