Jazzy 生成代码文档

iOS中能生成文档的有HeaderDoc、AppleDoc、Doxygen、Jazzy等，但是HeaderDoc、AppleDoc、Doxygen都不支持swift（至少目现在是这样），所以最后选择了Jazzy。

Jazzy 是一款可以为 Swift 和 Objective-C 代码产生具有 Apple 风格的代码文档工具.对于如何使用markdown对代码进行注释以及对Jazzy的介绍可以参考 原文链接

jazzy具体使用方法可以去访问 Github页面，安装方法如下：

1. 打开“终端”

2. 输入“sudo gem install jazzy”

3. 输入密码

4. 等待

1. 安装成功后cd到项目根目录下：

   $ cd path_to_project_folder
   例如：cd /Users/yuequ/Desktop/ZXPageController

2. 然后执行

   $ jazzy --min-acl internal

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

3. 然后在终端就会看到

   $ jam out ♪♫ to your fresh new docs in docs

   默认输出的文件夹位于工程的根目录（你也可以更改输出路径），叫 docs。

   使用 Finder 进入到对应路径，在浏览器中打开 index.html。你立即就会发现，默认生成的页面风格和 Apple 官方文档是非常相似的。如果不出问题到此就完成了。

说一下我在安装过成中遇到的坑

第一个问题：

ERROR: SSL verification error at depth 1: unable to get local issuer certificate (20)

ERROR: You must add /O=Digital Signature Trust Co./CN=DST Root CA X3 to your local trusted store

ERROR: SSL verification error at depth 1: unable to get local issuer certificate (20)

ERROR: You must add /O=Digital Signature Trust Co./CN=DST Root CA X3 to your local trusted store

ERROR: SSL verification error at depth 2: self signed certificate in certificate chain (19)

ERROR: Root certificate is not trusted (/C=US/O=GeoTrust Inc./CN=GeoTrust Global CA)

Fetching: liferaft-0.0.6.gem (100%)

Successfully installed liferaft-0.0.6

Fetching: xcinvoke-0.3.0.gem (100%)

Successfully installed xcinvoke-0.3.0

Fetching: sass-3.4.24.gem (100%)

ERROR: While executing gem ... (Errno::EPERM)

Operation not permitted - /usr/bin/sass

这个问题是因为需要安装或者升级ruby，然后重新执行sudo gem install jazzy就可以了

ruby安装：

$ curl -L get.rvm.io| bash -s stable

$ source ~/.bashrc

$ source ~/.bash_profile

查看当前ruby版本

$ rvm -v

列出已知的 Ruby 版本

$ rvm list known

比如更新ruby到2.4.0

$ rvm install 2.4.0

更新后就可以继续执行sudo gem install jazzy了

第二个问题：当我执行Jazzy时

Running xcodebuild

Could not parse compiler arguments from xcodebuild output.

Please confirm that xcodebuild is building a Swift module.

Saved xcodebuild log file: /var/folders/xz/7jvsntw524vc5vlzk7lqwml40000gn/T/xcodebuild-5E0C5A75-D91F-497C-AF96-08C9CC28E796.log

Failed to generate documentation

/Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/lib/jazzy/executable.rb:36:in execute_command': /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/bin/sourcekitten ["doc", "--"] (RuntimeError) Running xcodebuild Could not parse compiler arguments fromxcodebuildoutput. Please confirm thatxcodebuildis building a Swift module. Savedxcodebuildlog file: /var/folders/xz/7jvsntw524vc5vlzk7lqwml40000gn/T/xcodebuild-5E0C5A75-D91F-497C-AF96-08C9CC28E796.log Failed to generate documentation from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/lib/jazzy/sourcekitten.rb:217:inrun_sourcekitten'

from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/lib/jazzy/doc_builder.rb:67:in block in build' from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/lib/jazzy/doc_builder.rb:65:inchdir'

from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/lib/jazzy/doc_builder.rb:65:in build' from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/gems/jazzy-0.8.2/bin/jazzy:15:in'

from /Users/XXXX/.rvm/rubies/ruby-2.4.0/bin/Jazzy:23:in load' from /Users/XXXX/.rvm/rubies/ruby-2.4.0/bin/Jazzy:23:in

'

from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/bin/ruby_executable_hooks:15:in eval' from /Users/XXXX/.rvm/gems/ruby-2.4.0@global/bin/ruby_executable_hooks:15:in

'

只需要把项目commond + R 编译一下就行了。

RVM使用总结

bruce_wu 关注

2015.05.30 22:25* 字数 473 阅读 1273评论 0喜欢 5

rvm是一个便捷的多版本ruby环境的管理和切换工具 官网：https://rvm.io/

RVM安装

安装完成后为了提高安装速度，修改 RVM，改用淘宝镜像源 参考: http://ruby.taobao.org/

安装 Ruby

ruby版本切换与gemset的使用

• ruby版本切换与gemset的使用

  rvm use 2.0.0 #切换到ruby2.0.0版本

  rvm use 2.2.2 #切换到ruby2.2.2版本

• 创建gemset用来安装自己需要的环境

  rvm gemset create rails3.1.2

  rvm gemset create rails4.0.0

• 在gemset间切换

  rvm gemset use rails3.1.2

  rvm use [email protected] #使用use语句切换

• 别名

  由于ruby版本众多，且版本比较长，每次来回切换打字多比较麻烦，我们可以使用别名的方式来简化我们的输入

1. 创建别名

   rvm alias create 2.2 ruby-2.2.0

2. 查看已有别名

   rvm alias list

   输出

   default => ruby-2.2.0

   187 => ruby-1.8.7-p374

   r187 => ruby-1.8.7-p374

   2.2 => ruby-2.2.0

   1.8.7 => ruby-1.8.7-p374

3.删除别名

4.使用别名切换

更新RVM

项目自动加载 gemset

RVM 还可以在你cd 到项目的时候，RVM 会帮你自动加载 相应的gemset

只需要进入你的项目目录，建立一个 .rvmrc 文件

在这个文件里加一个命令

然后无论你当前 Ruby 设置是什么，cd 到这个项目的时候，RVM 会帮你加载 Ruby 2.2.0和 rails421 这个gemset

//一定要安装控制行

xcode-select --install