iOS-Xcode --- swift生成技术文档之jazzy

iOS-Xcode --- swift生成技术文档之jazzy

在网上看了很多都是针对OC项目的文档生成，找了好久终于看到jazzy这件神器了。下面看下如何安装使用：

安装

使用终端命令进行安装

~$ sudo gem install jazzy

使用

为了简单的展示，我在桌面创建了一个swift工程，工程名Demo。

• 1. 从终端进入工程目录

~$ cd ~/Desktop/Demo

• 2. 执行jazzy运行的命令

~$ jazzy --min-acl internal

另外，如果你的swift不是最新版的则看不到Jazzy的输出，这样的话需要添加一个参数来指定xcode所支持的swift版本:(xxx是你的swift的版本哦)

~$ jazzy --swift-version x.x.x --min-acl internal

• 3. 回车等待上一行命令运行完成

生成文档命令

等待终端命令运行如上图所示，代表成功。在工程目录下你可以看到会生成一个docs的文件夹。

操作后的工程目录

打开docs文件夹中的index.html

生成的文档

下面是源代码

swift代码