Jazzy在生成快速文档方面并没有像预期的那样工作。

Question

在进行了一些研究之后，找到了最好的方法来记录快速代码。我偶然发现Jazzy和实现起来是多么的简单。因此，我遵循Jazzy文档的安装部分。我跑

sudo gem install jazzy

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

我读过关于文档化代码的NSHipster教程，它也将您链接到Jazzy文档和标记格式引用。我已经记录了一些代码，Xcode在侧窗格中正确显示，或者右击函数或类。所以我相当肯定我的语法是正确的。

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

我在跑：

• jazzy版本: 0.3.2
• Xcode版本: 7.1
• 迅捷版: 2.1
• OS X El Capitan版本: 10.11

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

Answer 1

在更深入地阅读了关于jazzy的更多信息之后，我发现了这条重要的信息。

默认情况下，jazzy只记录公共声明。若要为可访问性级别较低(内部或私有)的声明生成文档，请将-min标志设置为内部或私有。

在jazzy git中心页面的故障排除部分。

我用下面的行进行了jazzy，以生成我期望的文档：

jazzy --min-acl private

，注意，，我应该把所有的东西都读一遍，然后我才会觉得有些东西不正常。

Answer 2

让它变得更好。使用

jazzy --min-acl internal --skip-undocumented

说明：

--min-acl internal这将包括您的纪录片中的所有函数、类、结构。

--skip-undocumented，这将忽略所有未记录的类..。