当前位置 : 主页 > 手机开发 > ios >

ios – 如何使用jazzy来记录我的快速项目?

来源:互联网 收集:自由互联 发布时间:2021-06-11
我想记录我的快速项目,我在 github上找到jazzy. 看完指南后,我创建了一个新的简单项目,想要试试,这里是我的ViewController,带有一些文档信息: import UIKit/**a view controller*/class ViewController:
我想记录我的快速项目,我在 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有关于我的视图控制器的一些信息,但结果是什么没有:

enter image description here

我想知道如何使用爵士,希望一些建议.

默认情况下,Jazzy只记录公共类,函数,属性等.因此,您可以执行以下两项操作之一:

>将public关键字添加到所需的类,方法和属性
文献.
> Ja000将记录的Change the privacy level.你可以改变
这与–min-acl标志:

jazzy --swift-version 2.1.1 --min-acl=internal
网友评论