jazzy生成Swift API文档

简介

jazzy 是一个命令行工具，用来生成 Swift 或 Objective-C 文档。

安装 jazzy

sudo gem install jazzy
或者
sudo gem install -n /usr/local/bin jazzy 安装指定目录

使用 jazzy

1.1 cd 你项目的文件夹（到xcodeproj文件目录）
2.1 执行以下代码，即可会成生成doc文件夹和build文件夹

jazzy --author 1111

如何设置Authors

执行 jazzy --author 名字 即可，–author 后面的名字按实际填写即可。

2.1 生成 html 文件在项目目录下

说明

Jazzy 默认只会对 public 和 open 访问权限的声明进行文档化。如果想要包含低级别的访问权限的话，可使用 --min-acl
命令，后面可携带 internal、fileprivate或private参数。

其他 jazzy 命令

jazzy 
  --clean 
  --author MyNam