jazzy生成代码解释文档

jazzy生成代码解释文档

========================
realm的jazzy的确好用

安装看官网

https://github.com/realm/jazzy

配置文件

这个不配置也可以生成文档,只是默认的文档比较丑,我用的文件如下

1
2
3
4
5
6
7
8
author: Saidong Zhang
author_url: https://zsd.name/
github_url: https://github.com/adong666666/InterfaceKit
root_url: https://zsd.name/InterfaceKit/
module: InterfaceKit
output: Docs
theme: fullwidth
xcodebuild_arguments: [-workspace, 'InterfaceKit.xcworkspace', -scheme, 'InterfaceKit']

命令行生成文档

我用这个命令行jazzy -o Docs将文档生成至Docs文件夹下,注意默认要在xcodeproj目录下执行。
这样一来,只要你的代码遵守iOS注释规范,就能生成非常漂亮的代码解释文档
文档截图