iOS-Xcode --- swift生成技术文档之jazzy（装逼利器）

之前写了一篇关于appledoc的使用文章，那时候主要是用oc编写项目使用很方便，最近用swift完成了一个项目之后想整理一份文档，却发现appledoc对于swift的注释不起作用了，试了几次都不行。
于是找到了另一个装逼利器----jazzy。看了jazzy的首页一脸懵逼啊，好像只有安装方式，之后通过查资料重要知道了怎么使用。闲言少叙书归正传。

一、安装

打开命令终端，输入
[sudo] gem install jazzy
运行等待，如图：

install.png

最终看到：

success.png

说明安装成功

二、使用

为了方便展示，我创建一个新的项目取名为appledoc(测试appledoc失败)。

• 1、终端中进入工程目录--- cd 你的工程目录

cd /Users/****/Desktop/appledoc

• 2、执行jazzy运行的命令： --min-acl internal

jazzy --min-acl internal

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

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

• 3、回车执行

  
  
  

  run.png
  
  

  默认输出文件夹命名docs，保存在工程的根目录下(可以修改)。打开你的工程目录找

  
  
  

  index.png
  打开就是你的文档了
  
  

  api.png
  
  

  是不是感觉和苹果官方风格的很像呢，点击可以看详情。
  不过对于oc使用没有成功，如果有朋友知道怎么使用的话，请指教一下。

希望对于各位同学有所帮助，赶紧来提升逼格吧！哈哈
别忘了喜欢点赞或者收藏哦。