ios - 在模块/文件夹级别添加源文档的可能性是什么？

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

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

如何以这样一种方式实现，即我们总是可以使用 Jazzy 之类的工具重新生成当前文档？

标签： iosswiftxcodemarkdowndocstring

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

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

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

[sudo] gem install jazzy

您需要为 jazzy 提供最小访问说明符

jazzy --min-acl internal

这里 internal 是访问说明符，如果您想包含私有文件用于文档，您可以提供私有。

jazzy 命令编译您的代码，然后为它创建文档。确保您的代码在创建文档之前编译。