苹果编程语言swift(swift语言现在怎么样了)
如果你逛swift的网站,你会发现他们的api文档,很多都用了jazzy文档生成工具,jazzy是realm公司发明的文档生成工具。
能为你的项目生成swift或者objective-c的api文档。
看起来挺美观的,毕竟非常接近苹果的样式和风格。
jazzy生成的文档的效果
代码仓库在:
https://github.com/realm/jazzy
jazzy本身是用ruby编写的,所以需要你的电脑需要有ruby才能运行。不过 大多数mac 的机器,已经有ruby了,所以不会是一个大问题。
安装jazzy也比较简单,运行
[sudo] gem install jazzy
就可以了。
用法很简单,示例生成swift的文档:
jazzy \ --clean \ --author Realm \ --author_url https://realm.io \ --source-host github \ --source-host-url https://github.com/realm/realm-cocoa \ --source-host-files-url https://github.com/realm/realm-cocoa/tree/v0.96.2 \ --module-version 0.96.2 \ --build-tool-arguments -scheme,RealmSwift \ --module RealmSwift \ --root-url https://realm.io/docs/swift/0.96.2/api/ \ --output docs/swift_output \ --theme docs/themes
当然每个选项都有它的作用,如果想知道具体选项有什么含义,请阅读官方的说明手册。
赞 (0)