我正在用 Swift 编写 SKD,我有一个示例项目作为目标。目标用于测试 SDK 进行的网络调用。
我的项目结构是这样的
-project
->sampleViewController
->storyboard
->plist
-pods
->core
->development
-> Main
-> Network
-> Objects
-> Protocols
-> Structs
-> RxSwift
-> Fakery
-> tw10
作为“开发”子文件夹的文件夹中的所有文件都是带注释的 swift 文件,当单击选项时显示我希望导出的注释
我已经下载了 jazzy,但我看不到一种指定路径扩展的方法,因为它似乎可以构建项目并删除目标的评论。
但是我不希望这样,因为目标中的所有代码都不是我完成后要发布的代码。
我的问题是,有没有办法传递文件夹扩展名,例如("/mac/project/target/development") 到 jazzy(或任何其他 gem 或程序)以便我可以为我的代码自动生成文档?或者在我全部输入之前,有没有人知道我可以使用的更好的解决方案或库!
最佳答案
当你运行 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
随便玩玩:)。
关于ios - 仅适用于 pod 文件夹的 Swift Auto Documentation jazzy,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36674385/