Jazzy是一款为Swift和Objective-C编写的文档生成工具，它通过AST来提供准确的代码文档。在macOS上，你可以通过安装Jazzy并使用命令行工具来生成项目文档。如果遇到安装或使用问题，如缺少ruby头文件或找不到clang，可以分别通过升级ruby、安装Xcode命令行工具和确保使用最新Xcode版本来解决。执行jazzy命令时，确保项目已编译，以避免错误。Jazzy生成的文档风格与官方文档一致，有助于提高开发效率和代码可维护性。
前言
对于开发人员而言，文档的作用不言而喻。文档不仅可以提高软件开发效率，还能便于以后的软件开发、使用和维护。上一篇主要讲述 Objective-C 生成文档，本篇主要讲述 Swift 快速生成开发文档工具 Jazzy。
简介
Jazzy 是 Swift 和 Objective-C 的文档生成工具。Jazzy 并不会解析源文件，而是使用 AST 来表示代码，并且提供准确的结果。Jazzy是一个命令行实用程序, 可以从已编译的 Swift 模块中生成文档，输出风格和官方文档匹配。
运行环境
- 建议在 macOS 上运行
- 支持 Xcode 和 Swift Package Manager 项目
安装
sudo gem install jazzy -n /usr/local/bin --verbose
使用
- 终端进入工程目录
cd /Users/yusheng/Desktop/Jazzy
- 执行命令行
jazzy --min-acl internal
# 选择 Swift 语言版本
jazzy --swift
最低0.47元/天 解锁文章
扫一扫
3078
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
