运用Jazzy生成工程的API文档

序言：运用Doxygen和HeaderDoc可以很方便地给OC工程生成API文档，但是当给Swift工程生成文档时，发现这个两个工具说不支持Swift。网上找了一番相关资料，可以通过Jazzy生成文档，文档也跟苹果官方的文档很相似，遂实践一把并记之。其中源代码中注释支持markdown注释。

1. 先看下文档的样式

   
   
   

   Snip20180701_1.png

而且会把Classes/Global Variables/Enumerations/Extensions/Type Aliases等分类展示。

2. 安装Jazzy,在终端输入命令: sudo gem install jazzy,提示输入密码后，就开始安装，看到如下代表安装成功。
   

   Snip20180701_2.png

3. cd到项目根目录后，运行命令jazzy --min-acl internal，如果是输入jazzy命令，则是只生产public和open修饰的项目。

   
   
   

   Snip20180701_3.png

4. 这是看到终端窗口中出现如下就代表一切正常，静待API文档的生成。

   
   
   

   Snip20180701_4.png
5. 出现jam out ♪♫ to your fresh new docs in docs后，到工程的根目录中查看结果，打开index.html文件展现在面前文档类型于苹果官方api文档样式。