A's*_*ens 13 documentation xcode ios swift jazzy
在做了一些关于记录swift代码的最佳方法的研究之后.我遇到了Jazzy,实施起来有多简单.所以我按照Jazzy文档的安装部分进行操作.我跑
sudo gem install jazzy
然后我导航到我的项目的根目录,在终端中运行jazzy,创建一个名为"docs"的文件夹,其中一个网站显示1个类的文档.我有87个课程,我可以在终端输出中看到jazzy循环.
我已经阅读了关于记录代码的NSHipster教程,该代码还将您链接到Jazzy文档以及标记格式参考.我已经记录了一些代码,Xcode在侧窗格中正确显示或右键单击函数或类.所以我很确定我的语法是正确的.
我花了一些时间将该1个文件与另一个未显示的文件进行比较,我没有看到任何与格式有关的异常.
我在跑:
我的整体问题是; 为什么不为所有类生成jazzy生成文档？如何解决此问题？
A's*_*ens 18
在深入阅读更多有关爵士乐的内容之后,我发现了这条重要的信息.
默认情况下,jazzy仅记录公共声明.要为具有较低可访问性级别(内部或私有)的声明生成文档,请将--min-acl标志设置为internal或private.
这是jazzy git hub页面的故障排除部分
我使用以下行运行jazzy以生成我期望的文档:
jazzy --min-acl private
注意我应该在我确定某些东西不能正常工作之前阅读所有内容.
Was*_*ine 10
使它更好.使用
jazzy --min-acl internal --skip-undocumented
说明:--min-acl internal这将包括纪录片中的所有函数,类,结构,
--skip-undocumented这将忽略所有未记录的类...
| 归档时间： |
|
| 查看次数： |
3031 次 |
| 最近记录： |