在 iOS/Xcode 项目中，通常使用带有 Markdown 的文档字符串在一个源文件中记录方法、属性、协议等。
但是，我找不到任何适当的方法来记录文件的“文件夹”。例如。我已经在不同的文件夹（“Xcode 组”）中对我的应用程序的功能进行了分类，并希望在该级别附加一些文档。例如，一个文件夹负责网络认证，它由多个源文件表示。
如何以这样一种方式实现，即我们始终可以使用 Jazzy 等工具重新生成当前文档？
【问题讨论】：
标签： ios swift xcode markdown docstring
Jazzy 不会根据文件夹记录文件。它创建类似 Apple 的文档，其中左侧按字母顺序命名文件。
生成文档唯一需要做的就是正确地注释您的代码。 Jazzy 解析您的评论并为其创建文档。
可以在终端使用这个命令安装Jazzy
[sudo] gem install jazzy
您需要为 jazzy 提供最小访问说明符
jazzy --min-acl internal
这里 internal 是访问说明符，如果你想包含私有文件用于文档，你可以提供 private。
jazzy 命令编译您的代码，然后为它创建文档。确保您的代码在创建文档之前编译。
请参考此文档：- https://medium.com/@_kenny/framework-friday-jazzy-c214fb9a5890
【讨论】：
Jazzy do not document files based on folder. 这就是我想要的。我知道 Jazzy 可以在文件级别上做什么，但我想要更上一层楼，基本上，我可以描述应用程序结构、模块以及所有内容如何组合在一起，因此新开发人员不必查阅外部文档和wiki 以获得概览。
--documentation 选项以包含更多 Markdown 文件。我想这就是我一直在寻找的东西……