swift生成文档工具-jazzy的使用教程

Jazzy 介绍

jazzy是一个命令行实用程序，可为Swift或Objective-C生成文档，输出风格和官方文档匹配(也可以自定义模板)，如下图所示

要求

1、支持Xcode和SPM项目
2、建议在macOS上运行

安装

建议使用下面指令

sudo gem install jazzy -n /usr/local/bin --verbose

错误使用命令

gem install jazz
sudo gem install jazzy
sudo gem install jazzy --verbose

提示错误如下

ERROR:  While executing gem ... (Gem::FilePermissionError)You don't have write permissions for the /usr/bin directory.

使用

从命令行运行jazzy。运行jazzy -h以获取其他选项的列表。

如果您的Swift模块是第一个要构建的模块，并且在运行时可以正常构建
如果xcodebuild或swift构建没有项目根目录的任何参数，则
只从项目的根开始运行爵士乐（不带任何参数）
也成功！

如果Jazzy为错误的模块生成文档，则使用–module告诉它哪个
一个你想要的。如果这样做没有帮助，并且您使用的是Xcode，请尝试传递
例如，xcodebuild的额外参数
爵士乐–build-tool-arguments -scheme，MyScheme，-target，MyTarget。

您可以在配置文件中为项目的文档设置选项，
.jazzy.yaml默认情况下。有关以下内容的详细说明和详尽列表
所有可用选项，运行jazzy --help config。

具备以下特性：

生成与Apple官方参考文档匹配的源代码文档
支持标准的Objective-C和Swift文档注释语法
利用现代HTML模板（Moustache）
利用Clang AST和SourceKit的强大功能和准确性
对Dash文档集的支持
支持Swift和Objective-C
文档注释的前提是有规范的注释

安装
终端运行

sudo brew install jazzy
1
基本使用
支持的文档标记
Swift

支持苹果官方 Swift 文档的基本文档注释，markdown 注释，官方参考，可以参考Cocoa 代码注释与文档生成 – 掘金.土土 Edmond 木方便易读

Objective-C

仅仅支持以下关键字

@param
@return
@warning
@see
@note
文档交叉链接

MyClass-的文档可以链接到MyClass。
MyClass.method（param1

swift生成文档工具-jazzy的使用教程相关推荐

Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
t通过数据库逆向生成文档工具——screw
目录一.pom.xml准备二.工具类配置及生成三.导出示例(html) 四.说明目标将数据库表字段分表生成表单,自动对应表字段以及注释,可导出为 html | doc | md 文件一.p ...
js代码注释生成文档工具-jsdoc
需求将js和ts的代码注释生成api文档思路先将ts转成js,再统一处理js文件,用jsdoc工具来生成html文件. JsDoc 是js文档生成工具,它从javascript程序源代码中抽取类 ...
项目实战-自动生成文档工具
1.pom 文件 <dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-c ...
docwizard c++程序文档自动生成工具_如何开发一个基于 TypeScript 的工具库并自动生成文档
为什么用 TypeScript? TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. Any ...
Doxygen——根据代码注释生成文档的工具
文章目录 1 简介 2 安装 3 使用 3.1 注释代码 3.2 使用doxywizard生成文档 4 用例 4.1 OpenCV 4.2 Apollo 5 参考 1 简介 Doxygen是一个可以根 ...
测试接口生成文档的工具 APIFOX
超乎意料好用的接口测试工具! 和Postman相似的操作流程,能测试接口,能自动生成文档,支持不同环境的变量配置,支持保存测试用例,支持导入其他软件的测试接口文件,支持多人在线查看和测试接口,支持多项 ...
linux c/c++ 代码使用 doxygen 自动生成文档
www.doxygen.org 的使用非常方便,下面分成2步介绍一下 1. 注释风格,需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的 C++的注释风格主要使用下面这种样式:即在注释 ...

swift生成文档工具-jazzy的使用教程

Jazzy 介绍

要求

安装

使用

swift生成文档工具-jazzy的使用教程相关推荐

最新文章

热门文章