Swift 仅适用于 pod 文件夹的自动文档爵士乐

Question

我正在 Swift 中编写 SKD，并且我有一个示例项目作为目标。目标用于测试 SDK 进行的网络调用。

我的项目结构是这样的

-project
  ->sampleViewController
  ->storyboard
  ->plist
-pods
  ->core
    ->development
      -> Main
        -> Network
        -> Objects
        -> Protocols
        -> Structs
  -> RxSwift
  -> Fakery
  -> tw10

作为 'development' 子文件夹的文件夹中的所有文件都被注释 swift 文件，当单击选项时显示我希望导出的注释

我已经下载了 jazzy，但我看不到指定路径扩展的方法，因为它似乎可以构建项目并删除目标的注释。

但是我不想要这个，因为我的目标中的所有代码都不是我完成后要发布的代码。

我的问题是，有没有办法传递文件夹扩展名，例如("/mac/project/target/development") 到 jazzy（或任何其他 gem 或程序）以便我可以为我的代码自动生成文档？或者在我全部输入之前，有没有人知道我可以使用的更好的解决方案或库！

Answer 1

当你运行 jazzy -h 并且你可以看到

    --source-directory DIRPATH   The directory that contains the source to be documented
-e, --exclude file1,file2,…fileN Files to be excluded from documentation

随便玩玩:)。

Answer 2

随便写：

jazzy --podspec PathOfYourPodspec

...您的文档文件夹将被创建。

Swift 仅适用于 pod 文件夹的自动文档爵士乐

Swift Auto Documentation jazzy for pod folder only

documentation-generation

ios

swift

jazzy