Question

在对文档快速代码的最佳方法进行一些研究之后。我遇到了Jazzy，实施起来有多简单。所以我按照Jazzy Documentation的安装部分进行操作。我跑

.wrapper{
    background: #f1f1f1;
    width: 100%;
    border-top: 5px solid #d1b792;
    border-bottom: 5px solid #d1b792;
    padding-bottom: 1px;
}
.nav li{
    display: inline-block;
    margin-left: -4px;
}
.nav li a{
    display: block;
    font-size: 18px;
    padding: 0px 12px 3px 12px;
    margin: 5px 0;
    color: #666694;
    line-height: 12px;
    border-right: 2px solid #4679BD;
    text-decoration: none;
}
.nav li a:hover{
    color: darkblue;
}
.nav li:last-child a{
    border-right: none;
}

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

我已阅读有关记录代码的NSHipster Tutorial，该代码也会将您与Jazzy Documentation以及Markup Formatting Reference相关联。我已经记录了一些代码，Xcode在侧窗格中正确显示或右键单击函数或类。所以我很确定我的语法是正确的。

我花了一些时间将这个1文件与另一个没有显示的文件进行比较，我没有看到任何与格式不同的文件。

我正在跑步：

爵士版：0.3.2
Xcode版本：7.1
Swift版本：2.1
OS X El Capitan版本：10.11

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

Answer 1

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

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

jazzy git hub page

的故障排除部分

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

AVDXmfJ3Ou7LzqD1DDMj

注意我应该先阅读所有内容，然后才能确定某些内容无效。

Answer 2

让它变得更好。使用
jazzy --min-acl internal --skip-undocumented
说明：
--min-acl internal这将包括纪录片中的所有功能，类别，结构 --skip-undocumented这将忽略所有未记录的类......

Jazzy因为生成快速文档而无法按预期工作

2 个答案: