14

在对记录 swift 代码的最佳方法进行了一些研究之后。我遇到了 Jazzy，它的实现非常简单。所以我遵循Jazzy 文档的安装部分。我跑

sudo gem install jazzy

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

我已经阅读了有关文档化代码的NSHipster 教程，该教程还将您链接到Jazzy 文档以及标记格式参考。我已经记录了一些代码，Xcode 可以在侧窗格中正确显示或右键单击函数或类。所以我相当肯定我的语法是正确的。

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

我在跑：

  • 爵士版：0.3.2
  • Xcode 版本：7.1
  • 斯威夫特版本：2.1
  • OS X El Capitan 版本：10.11

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

4

2 回答 2

20

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

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

这是jazzy git hub 页面的故障排除部分

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

jazzy --min-acl private

请注意，在我决定某些东西不能正常工作之前，我应该阅读所有内容。

于 2015-11-05T12:28:41.040 回答
11

让它变得更好。使用
jazzy --min-acl internal --skip-undocumented
说明：
--min-acl internal这将包括文档中的所有函数、类、结构，
--skip-undocumented这将忽略所有未记录的类...

于 2015-11-21T20:04:45.433 回答