Ios Jazzy无法按预期生成swift文档
在研究了记录swift代码的最佳方法之后。我遇到了Jazzy,以及它的实现是多么简单。因此,我遵循的安装部分的。我跑 然后,我在终端中导航到我的项目的根目录,运行Ios Jazzy无法按预期生成swift文档,ios,swift,xcode,documentation,jazzy,Ios,Swift,Xcode,Documentation,Jazzy,在研究了记录swift代码的最佳方法之后。我遇到了Jazzy,以及它的实现是多么简单。因此,我遵循的安装部分的。我跑 然后,我在终端中导航到我的项目的根目录,运行jazzy,它创建了一个名为“docs”的文件夹,其中包含一个显示1个类的文档的网站。我有87个类,我可以在终端输出中看到jazzy循环 我已经阅读了关于文档化代码的内容,它还将您链接到。我已经记录了一些代码,Xcode会正确地显示在侧窗格中,或者右键单击函数或类。所以我相当肯定我的语法是正确的 我花了一些时间将这1个文件与另一个没有显
jazzy
,它创建了一个名为“docs”的文件夹,其中包含一个显示1个类的文档的网站。我有87个类,我可以在终端输出中看到jazzy循环
我已经阅读了关于文档化代码的内容,它还将您链接到。我已经记录了一些代码,Xcode会正确地显示在侧窗格中,或者右键单击函数或类。所以我相当肯定我的语法是正确的
我花了一些时间将这1个文件与另一个没有显示的文件进行比较,我没有看到任何与格式有关的异常
我在跑步:
- 爵士版本:0.3.2
- Xcode版本:7.1
- Swift版本:2.1
- OS X El Capitan版本:10.11
我的整体问题是,;为什么jazzy没有为所有类生成文档?我如何解决这个问题?在更深入地阅读了有关jazzy的更多信息后,我发现了这条重要信息 默认情况下,jazzy仅记录公共声明。产生 具有较低可访问性级别的声明的文档 (内部或专用),请将--min acl标志设置为内部或 私人的 这是在故障排除部分的 我使用以下行运行jazzy以生成我期望的文档:
jazzy --min-acl private
注意我应该先阅读所有内容,然后再决定是否有问题。让事情变得更好。使用
jazzy--min acl internal--skip undocumented
说明:
--min acl internal
这将包括文档中的所有函数、类和结构--跳过未记录的
这将忽略所有未记录的类…oo谢谢,我很恼火它说的是68%已记录,有没有办法记录所有ACL(公共、私有、内部?)如果我使用--minacl internal
我看不到正在记录的公共方法。在类的顶部添加一个文档&这会很有用!你太棒了,我真的在找这样的旗帜。谢谢
jazzy --min-acl private