ios - Jazzy 无法按预期生成快速文档

Question

在对记录 swift 代码的最佳方式进行一些研究之后。我遇到了 Jazzy，它的实现是多么简单。所以我按照 Jazzy Documentation 的安装部分进行操作.我跑

sudo gem install jazzy

然后，我在终端中导航到项目的根目录，并运行 jazzy，它创建了一个名为“docs”的文件夹，其中包含一个显示 1 类文档的网站。我有 87 个类，我可以在终端输出中明显地看到 jazzy 循环。

我读过 NSHipster Tutorial关于记录代码，它也将您链接到 Jazzy Documentation以及 Markup Formatting Reference .我已经记录了一些代码，Xcode 可以在侧 Pane 中或右键单击函数或类时正确显示这些代码。所以我相当确定我的语法是正确的。

我花了一些时间将 1 个文件与未显示的另一个文件进行比较，我没有发现任何格式方面的异常。

我在运行:

• 爵士版:0.3.2
• Xcode 版本:7.1
• swift 版本:2.1
• OS X El Capitan 版本:10.11

我的总体问题是；为什么 jazzy 不为所有类生成文档，我该如何解决这个问题？

Answer 1

在更深入地阅读了有关爵士乐的更多内容后，我发现了这条重要信息。

By default, jazzy only documents public declarations. To generate documentation for declarations with a lower accessibility level (internal or private), please set the --min-acl flag to internal or private.

在 jazzy git hub page 的故障排除部分

我使用以下行运行 jazzy 以生成我期望的文档:

jazzy --min-acl private

注意我应该在确定某事不正常之前阅读所有内容。