Jazzy 未按预期生成 swift 文档
Jazzy is not working as expected for generating swift documentation
在对记录 swift 代码的最佳方式进行一些研究之后。我遇到了 Jazzy，它的实现是多么简单。所以我按照Jazzy Documentation的安装部分。我运行
sudo gem install jazzy
然后我在终端中导航到项目的根目录，然后 运行 jazzy 创建一个名为 "docs" 的文件夹，其中包含一个显示 1 class。我有 87 classes，我可以在终端输出中明显地看到爵士乐循环。
我已经阅读了关于记录代码的 NSHipster 教程，它还链接到 Jazzy Documentation 以及 标记格式参考。我已经记录了一些代码，Xcode 可以在侧面板或右键单击函数或 class 中正确显示。所以我很确定我的语法是正确的。
我花了一些时间将 1 个文件与未显示的另一个文件进行比较，我没有发现任何格式方面的异常。
我是运行宁：
- 爵士版：0.3.2
- Xcode版本：7.1
- Swift版本：2.1
- OS X El Capitan 版本：10.11
我的总体问题是；为什么 jazzy 不为所有 classes 生成文档，我该如何解决这个问题？
在更深入地阅读了有关爵士乐的更多内容后，我发现了这条重要信息。
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 --min-acl private
注意我应该先阅读所有内容，然后再判断是否有问题。
让它变得更好。使用
jazzy --min-acl internal --skip-undocumented
解释 :
--min-acl internal 这将包括您的纪录片
中的所有函数、类、结构
--skip-undocumented 这将忽略所有未记录的 类...
在对记录 swift 代码的最佳方式进行一些研究之后。我遇到了 Jazzy，它的实现是多么简单。所以我按照Jazzy Documentation的安装部分。我运行
sudo gem install jazzy
然后我在终端中导航到项目的根目录，然后 运行 jazzy 创建一个名为 "docs" 的文件夹，其中包含一个显示 1 class。我有 87 classes，我可以在终端输出中明显地看到爵士乐循环。
我已经阅读了关于记录代码的 NSHipster 教程，它还链接到 Jazzy Documentation 以及 标记格式参考。我已经记录了一些代码，Xcode 可以在侧面板或右键单击函数或 class 中正确显示。所以我很确定我的语法是正确的。
我花了一些时间将 1 个文件与未显示的另一个文件进行比较，我没有发现任何格式方面的异常。
我是运行宁：
- 爵士版：0.3.2
- Xcode版本：7.1
- Swift版本：2.1
- OS X El Capitan 版本：10.11
我的总体问题是；为什么 jazzy 不为所有 classes 生成文档，我该如何解决这个问题？
在更深入地阅读了有关爵士乐的更多内容后，我发现了这条重要信息。
的故障排除部分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 --min-acl private
注意我应该先阅读所有内容，然后再判断是否有问题。
让它变得更好。使用
jazzy --min-acl internal --skip-undocumented
解释 :--min-acl internal 这将包括您的纪录片
中的所有函数、类、结构
--skip-undocumented 这将忽略所有未记录的 类...