在Swift中记录

我们没有任何借口：记录我们的代码从未如此简单。 Swift工程师做了出色的工作，为我们提供了一种众所周知的简单方式来保持我们的代码记录：标记语言。 我制作了一个信息图，为您提供实现此目的最有用的技巧。 以下是简要概述。

我们需要知道的所有内容可以通过两件事进行综合：如何格式化以及Swift如何组织和显示文档。

如何格式化

我们几乎可以使用任何markdown语法在Swift代码中格式化我们的文档：预定义的标题，强，斜体，项目符号列表，编号列表，链接，嵌入式代码等。

Swift如何组织和显示您的文档

Swift使用以下部分按此顺序组织方法的文档（我们只需要使用正确的关键字来激活可选的关键字即可）：

1. 说明（默认）：在这里我们可以指定很多东西：作者，版权，警告，注释，版本等。
2. 参数（可选）
3. 退货（可选）
4. 抛出（可选）

例如：

然后，在Option上单击我们的方法或在实用工具栏中选择询问标记时，将显示格式化的文档：

我们还可以使用一些注释标签来分隔代码：

• //标记：
• // 去做：
• // 整我：

例如：

这将显示在我们代码上方的栏中：

我们可以使用Jazzy以精美的方式呈现文档。

坦白地说，为了我们的团队成员或将来的自己，每个人都应该这样做，因为从现在开始的几个月内，他们将与我们自己的代码取得联系。