jazzy是一个命令行实用程序,可为Swift或Objective-C生成文档
关于
Swift和Objective-C项目均受支持。
与解析源文件不同, jazzy钩接到和以使用代码的表示及其注释来获得更准确的结果。 输出与WWDC 2014之后的苹果官方参考文档的外观和风格相匹配。
Jazzy还可以代替源代码从编译的swift模块生成文档。
该项目遵守《 。 通过参与,您将坚持此代码。 请向报告不可接受的行为。
要求
您需要开发工具来构建要记录的项目。 Jazzy支持和项目。
Jazzy期望在macOS上运行。 有关在Linux上运行Jazzy的提示,请参见。
安装
[sudo] gem install jazzy
请参阅以获取一些常见问题的解决方案。
用法
从命令行运行jazzy 。 运行jazzy -h以获取其他选项的列表。
如果您的Swift模块是第一个要构建的模块,并且在运行xcodebuild或swift build时,它在项目根目录下没有任何自变量的情况下构建良好,那么仅从项目根目录运行jazzy (无任何自变量)也应该会成功!
如果Jazzy为错误的模块
评论0
最新资源