Question

在iOS / Xcode项目中，通常使用带有Markdown的文档字符串来在一个源文件中记录方法，属性，协议等。

但是，我找不到用于记录文件“文件夹”的任何正确方法。例如。我已经在不同的文件夹（“ Xcode组”）中对应用程序的功能进行了排序，并希望在该级别上附加一些文档。例如，一个文件夹负责网络身份验证，它由多个源文件表示。

该如何实现以使我们始终可以使用Jazzy之类的工具来重新生成当前文档？

Answer 1

Jazzy不会根据文件夹记录文件。它创建类似于Apple的文档，在左侧按字母顺序命名文件。

生成文档唯一需要做的就是正确注释代码。 Jazzy解析您的评论并为其创建文档。

可以在终端中使用此命令来安装Jazzy

[sudo] gem install jazzy

您需要为爵士乐提供最少的访问说明

jazzy --min-acl internal

内部是访问说明符，如果要包含私人文件作为文档，则可以提供私有。

jazzy命令会编译您的代码，然后为其创建文档。创建文档之前，请确保您的代码已编译。