ios - 在模块/文件夹级别添加源文档的可能性有哪些？

Question

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

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

如何才能实现这一点，让我们始终可以使用 Jazzy 等工具重新生成当前文档？

Answer 1

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

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

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

[sudo] gem install jazzy

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

jazzy --min-acl internal

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

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

请参阅此文档:- https://medium.com/@_kenny/framework-friday-jazzy-c214fb9a5890