IOS 技术分享| iOS 快速生成开发文档(二)
前言
对于开发人员而言,文档的作用不言而喻。文档不仅可以提高软件开发效率,还能便于以后的软件开发、使用和维护。上一篇主要讲述 Objective-C 生成文档,本篇主要讲述 Swift 快速生成开发文档工具 Jazzy。
简介
Jazzy 是 Swift 和 Objective-C 的文档生成工具。Jazzy 并不会解析源文件,而是使用 AST 来表示代码,并且提供准确的结果。Jazzy 是一个命令行实用程序, 可以从已编译的 Swift 模块中生成文档,输出风格和官方文档匹配。
运行环境
建议在 macOS 上运行
支持 Xcode 和 Swift Package Manager 项目
安装
复制代码
使用
终端进入工程目录
复制代码
执行命令行
复制代码
常见问题
1.安装问题
复制代码
解决:
复制代码
2.安装问题
复制代码
执行下命令即可:
复制代码
3.安装问题
复制代码
更新至 macOS 10.14.4 或更高版本;或者
安装 Xcode 10.2 或更高版本在/Applications/Xcode.app.
4.执行 jazzy 命令是问题
复制代码
将项目编译下即可执行成功
文档生成效果
版权声明: 本文为 InfoQ 作者【anyRTC开发者】的原创文章。
原文链接:【http://xie.infoq.cn/article/194ff244851a215fc391abe2d】。文章转载请联系作者。
评论