VVDocumenter + jazzy 自动生成Swift文档

1,安装 https://github.com/realm/jazzy

[sudo] gem install jazzy

2,  使用VVDocumenter插件编写注释,

安装:https://github.com/onevcat/VVDocumenter-Xcode

其他注释参考:http://nshipster.com/swift-documentation/

3,终端运行:

jazzy --swift-version 2.1.1 --min-acl private | internal | public

-bash: internal: command not found -bash: public: command not found 这两个提醒不用理会。等待编译结束,工程目录下有多出docs文件夹,打开index.html,就可以阅读文档了

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,756评论 2 45
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,073评论 19 139
  • Part One 论及“没有,就去创造”这个话题,我的脑海里便会不由自主地浮现出近期曾积极主动经历过一件事...
    吖坤要加油阅读 3,604评论 3 1
  • 精神病的世界观,不得不说,精神病想的东西很多,很深。看完以后我都开始怀疑我的世界了,我都不知道世界上还有这些人,他...
    依米花1993阅读 3,471评论 0 0
  • 有人这样算过,一个销售的从初次访客户到达成,中间跟单基本要5-8次才可下单,我想说这个此事确实不多,都是一些刚做销...
    追风筝的秘密阅读 3,150评论 0 0

友情链接更多精彩内容