在对文档swift代码的最佳方式进行了一些研究之后。我遇到了Jazzy,实现起来多么简单。所以我按照Jazzy Documentation的安装部分。我跑Jazzy没有像预期的那样生成快速文档
sudo gem install jazzy
然后我浏览到我的项目的根,在终端,并运行jazzy
它创建了一个名为“文档”有一个网站,1类显示文档的文件夹。我有87个班级,可以在终端输出中看到爵士乐循环播放。
我已阅读NSHipster Tutorial有关记录代码的信息,这些代码也将您链接到Jazzy Documentation以及Markup Formatting Reference。我记录了一些代码,Xcode在侧窗格中正确显示或右键单击函数或类。所以我相当肯定我的语法是正确的。
我花了一些时间将这1个文件与另一个没有被显示的文件进行比较,并且我没有发现与格式有关的任何内容。
我运行:
- 爵士版本:0.3.2
- 的Xcode版本:7.1
- 斯威夫特版本:2.1
- OS X埃尔卡皮坦版本:10.11
我的整体问题是;为什么不是为所有课程生成文档,我该如何解决这个问题?
OO谢谢,我很生气怎么说,像记录68% –
有没有一种方法来记录所有ACL(公共,私人,内部?) 如果我使用'--min-acl internal',我没有看到公开的方法被记录。 – 2016-04-13 12:37:06
将文档添加到课程顶部,它将起作用 –