框架星期五：爵士乐

欢迎大家回来，我很高兴你们回来了另一个精彩的Framework Friday帖子。 今天，我们将回顾我的个人最爱：Jazzy（https://github.com/realm/jazzy）。 Jazzy是由Realm的杰出人士构建而成的，因此请在此处查看他们：https://realm.io/

什么是爵士乐？

jazzy是一个命令行实用程序，可为Swift或Objective-C生成文档。 与解析源文件不同，Jazzy钩接到Clang和SourceKit中，以使用代码的AST表示及其注释来获得更准确的结果。 输出结果与Apple官方参考文档（WWDC 2014之后）的外观相符。

从本质上讲，爵士乐将使您的生活更加有趣，并使生活变得更好十倍😉

爵士乐在几乎所有方面都非常简单。 安装Jazzy只需从我们的终端执行一个命令：

  [sudo] gem install jazzy 

塔达，都做完了 接下来，我们必须在代码中添加注释。 使用Jazzy会使这个过程变得非常有趣，因为说完并完成之后，我们将获得一个显示我们评论的网页！

在开始记录代码之前，我们需要了解Markdown语法。 基本上，Markdown语法使用特殊字符来格式化文本。 这里有一些资源，其中包含有关Markdown语法的更多信息：https://guides.github.com/features/mastering-markdown/和https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide- 776639995.html。

让我们看一些基本知识。

 1.＃此文本现在是标题＃ 
  2. *此文本将以斜体显​​示* 
 3. **This text will be bold** 

1. 如果将主题标签放在一段文本之前，它将变成标题。 在此之前和之后添加更多＃会更改文本的大小。
2. 在一行文本之前和之后仅添加一个星号将使其斜体。
3. 前后添加两个星号将使其加粗。

很简单吧？

  *我的无序列表项目1 
  *我的无序列表项目2 

在文本前面仅添加一个星号会将其转换为无序列表（项目符号点）。

  1.我的订购清单项目1 
  1.我的订购清单项目2 
  1.我的订购清单项目3 

同样，不添加星号，而是添加“ 1.”会将您的文本转换为有序列表。

现在我们已经解决了这个问题，让我们将其付诸实践。

在此处下载示例项目：https://github.com/kennyDang/Guides/tree/master/Framework%20Fridays/Jazzy%20Example

在示例项目中，您将看到我们有几个不同的文件夹。 一个叫做协议，另一个叫做模型。 如果您对它们进行了窥视，将会看到一些超简单的文件和已记录的代码。 我们唯一的协议称为SuperCoolProtocol ，只有一个函数称为displayCoolMessage。 我不知道当我们遵守此协议时会发生什么……好事，我们有文档的力量！ 我们不必猜测它的作用，因此让我们看一下评论。

  / **＃超级酷协议信息＃ 
 符合此协议的对象必须显示 
 很酷的信息。* / 

您会注意到，协议上方的块注释不仅仅是一个简单的双正斜杠。 Xcode会忽略这些类型的注释，因此Jazzy将无法使用它。 相反，我们将使用块注释。

在该块内部，我们使用了第一个Markdown语法！ 它将“超酷协议信息”转换为标题。 它将作为该协议的标题。 在这下面只是一条简单的文本行。 现在，如果我们命令单击我们的协议并点击“显示快速帮助”，我们将看到我们方便的文档！

是时候看看我们的模型文件夹了。 我们有一个名为Duck的结构。 我们为Duck提供了一个熟悉的注释块，但这次我们内部有一个代码块！ 向后四个勾（`）将创建一个代码块。

  / **这是一个鸭子对象。###用法示例###````let duck = Duck（）duck.displayCoolMessage（message：“ quack”）`` 

单击命令并显示快速帮助将显示以下内容：

我们的鸭子类型具有年龄属性。 我们可以确保使用三斜杠来记录它。

  ///鸭子的年龄 
 变量年龄：整数 

再一次，如果我们点击“显示快速帮助”，就可以在Xcode中看到它。

现在我们已经记录了代码，让我们开始使用Jazzy。 首先，我们必须导航到终端中的项目文件夹。 确保您在正确的目录中！ Jazzy需要能够看到xcode项目。 这是您浏览到项目文件夹后终端的外观。

爵士乐在选择方面非常灵活。 默认情况下，Jazzy将仅解析公开或公开的代码。 因此，请确保您相应地设置访问者级别。 如果我们在实际项目中工作，则可以运行此命令。

 爵士乐 

但是为了简单起见，我们将通过在终端中运行以下行来包括所有内容：

 爵士乐--min-acl内部 

坐下来放松一下，同时Jazzy解析您的文件🙌。 完成所有操作后，我们应该看到一个名为“ docs”的新文件夹，其中包含我们代码的网页表示形式。 查找名为index.html的文件，然后在您喜欢的浏览器中打开它。 太好了吧？ 网页上的所有代码，供我们欣赏。

结论

Jazzy是一个非常有趣的库，如果您想为自己的代码编写工作增添一丝风味。

总体而言，我给出了这个框架5.占5。

有特定的框架吗？ 让我知道，我可能会复习一下！ 如果您喜欢这篇文章，请砸一下拍手按钮几百万次，然后通知我！

后来，伙计们。 ✌️