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

时间:2015-12-24 09:07:19

标签: ios swift document jazzy

我想记录我的快速项目,并在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,希望得到一些建议。

4 个答案:

答案 0 :(得分:4)

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

  1. public关键字添加到所需的类,方法和属性中 文档。
  2. Jazzy将记录的
  3. Change the privacy level。你可以改变 这与--min-acl标志:

    jazzy --swift-version 2.1.1 --min-acl=internal
    

答案 1 :(得分:3)

在swift 3上

jazzy --min-acl=internal

答案 2 :(得分:0)

是的,如果您只是运行BufferIterator& operator+=(const difference_type& n) { if (n >= 0) { if (_pos < b._gapStart && b._gapStart <= _pos + n) { _pos += b._gapEnd - b._gapStart; } } else { if (_pos + n <= b._gapEnd && b._gapEnd < _pos) { _pos -= (b._gapEnd - b._gapStart); } } _pos += n; return *this; } ,jazzy只是假设您希望默认访问控制级别为jazzy

因此,除非我们使用public注释内容,否则最终文档将不会显示论文。默认级别为public

提示

您可以创建internal,并在其中放置配置。所以在此之后,就可以了。

.jazzy.yaml

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

参考:Siesta's jazzy

答案 3 :(得分:0)

建议通过创建.jazzy.yaml文件进行尝试并配置详细信息。 在终端中仅输入“ jazzy”的帖子将生成文档。

  

$爵士乐

有关此链接的详细信息,它是一个循序渐进的指南以及一个示例swift项目:

https://medium.com/@sumit16.kumar/document-generation-for-swift-projects-using-jazzy-e148efc72bca

希望这会有所帮助!