ios - 如何使用 jazzy 来记录我的 swift 项目？

Question

我想记录我的 swift 项目，我在 github 上找到了 jazzy。在查看指南后，我创建了一个新的简单项目并想尝试一下，这是我ViewController的一些文档信息：

import UIKit
/**
a view controller
*/
class ViewController: UIViewController {
// MARK: property
/// a simple var
var hello = 200

// MARK: Func
/// view did load
override func viewDidLoad() {
    super.viewDidLoad()
    // Do any additional setup after loading the view, typically from a nib.
    print(add(2, b: 2))
}
/// did receiveMemoryWarning
override func didReceiveMemoryWarning() {
    super.didReceiveMemoryWarning()
    // Dispose of any resources that can be recreated.
}

/// a document test func
func add(a:Int, b:Int)->Int{
    return a + b
    }
}

这是我的命令：

    ➜  DocumentDemo git:(master) ✗ jazzy --swift-version 2.1.1 \
--clean \
--author helloworld \
-x -scheme,DocumentDemo
Running xcodebuild
Parsing ViewController.swift (1/3)
Parsing AppDelegate.swift (2/3)
Parsing My.swift (3/3)
building site
jam out ♪♫ to your fresh new docs in `docs`
➜  DocumentDemo git:(master) ✗

我希望 html 有一些关于我的视图控制器的信息，但结果没有：

我想知道如何使用jazzy，希望得到一些建议。

score 5 · Accepted Answer

默认情况下，Jazzy 只记录public类、函数、属性等。所以你可以做以下两件事之一：

将public关键字添加到您想要记录的类、方法和属性。
更改Jazzy 将记录的隐私级别。您可以使用以下--min-acl标志更改它：
```
jazzy --swift-version 2.1.1 --min-acl=internal
```

score 3 · Accepted Answer

3

在 swift 3 上

jazzy --min-acl=internal

于 2017-03-09T17:01:11.813 回答

score 1 · Accepted Answer

是的，如果你只是运行jazzy，jazzy 只是假设你想要默认的访问控制级别是public.

因此，除非我们用注释事物，否则public最终文档不会显示论文。默认级别是internal。

小费

您可以创建一个.jazzy.yaml, 并将配置放在那里。所以在这之后，就可以运行了。

$ jazzy

Jazzy 将解析我们配置的 yaml 文件。

参考：午睡的爵士乐

ios - 如何使用 jazzy 来记录我的 swift 项目？

3 回答 3

Related

Reference