Jazzy 文档生成器使用

Jazzy 简介

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

如果是 Swift和 Objective-C 混合项目生成文档，需要通过 SourceKitten 生成分别生成 swift和 Objective-C 然后再利用 jazzy 生成文档，详情参考 github README 中 Mixed Objective-C/Swift部分。

具备以下特性：

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

文档注释的前提是有规范的注释

安装

终端运行

sudo brew install jazzy

基本使用

支持的文档标记

Swift

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

Objective-C

仅仅支持以下关键字

@param
@return
@warning
@see
@note

文档交叉链接

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

Jazzy 文档生成器使用相关推荐
1. Sandcastle帮助文档生成器使用介绍
  一.软件介绍 Sandcastle是一个管理类库的文档编译器,是用于编译发布组件(Assembly)信息的一个工具,这个工具通过反射和 Xslt技术,可以从dll文件及其xml注释(命令行编译时加/d ...
2. simple css 汉化,Simple CSS(CSS文档生成器)
  Simple CSS(CSS文档生成器)简介 Simple CSS(CSS文档生成器)简介一:Simple CSS是一款CSS文档生成器,帮助网页开发人员快速生成CSS样式,Simple CSS使用非 ...
3. 开源数据库表结构文档生成器
  大家好,我是TJ 一个励志推荐10000款开源项目与工具的程序员 TJ君前几天和一个在银行科技部上班的同学聚会,同学跟TJ君吐槽,一些小银行的科技表面看上去专业,实际各种马虎不负责. 打个比方,有一次 ...
4. python文档生成工具_pydoc --- 文档生成器和在线帮助系统 — Python 3.9.1rc1 文档
  pydoc --- 文档生成器和在线帮助系统¶ The pydoc module automatically generates documentation from Python modules. ...
5. JSDoc --JS API文档生成器
  JSDoc 是一个JavaScript的API文档生成器. 他可以让开发者在开发的过程中, 将编写的注释通过JSDoc工具生成一个api文档, 妈妈再也不用担心我不会写接口文档了. 这里是原作者Git ...
6. django 1.8 官方文档翻译：7-3 Django管理文档生成器
  Django管理文档生成器 Django的admindocs应用从模型.视图.模板标签以及模板过滤器中,为任何INSTALLED_APPS中的应用获取文档.并且让文档可以在Django admin中使 ...
7. 发布CHM文档生成器可替代 HTML Help Workshop，有全部C#源代码
  CHM文档生成器现在的程序很多配备CHM格式的帮助文件,一般的开发者使用 HTML Help Workshop 来定义CHM文档,但操作不甚方便,而CHM文档生成器就可用来很方便的编辑CHM文档结构 ...
8. python 文档生成_文档生成器 mkdocs
  mkdocs 是 Python 一个对 Markdown 非常友好的文档生成器,中文文档地址使用 mkdocs 我们可以用md 编写自己的文档,而且可以免费部署到 GitHub . 安装 pip i ...
9. PHP文档生成器（PHPDoc）的基本用法
  目录 PHP文档生成器(PHPDoc)的基本用法 PHPDoc概述安装 PHPDoc注释规范页面级别的注释代码级别的注释生成API文档额外软件 PHP文档生成器(PHPDoc)的基本用法 P ...
最新文章
热门文章

Jazzy 文档生成器使用

Jazzy 简介

安装

基本使用

支持的文档标记

Jazzy 文档生成器使用相关推荐

最新文章

热门文章