美文网首页
xcode自动导出API文档

xcode自动导出API文档

作者: 小白也疯狂 | 来源:发表于2018-07-04 10:40 被阅读0次


    1.需求

    最近在做sdk开发,产品需要API文档,用到了appledoc,它能够完美的支持xcode自带的注释格式,还支持很多其他格式,有兴趣的自己研究,这是一个非常简单实用的开源工具!

    2.安装appledoc

    (1)第一步:下载安装

    git clone git://github.com/tomaz/appledoc.git

    cd ./appledoc

    sudo sh install-appledoc.sh

    (2)第二步:安装验证:

    appledoc--version

    3.使用方法

    (1)在终端进入要导出文档的工程目录

    cd 项目路径

    (2)输入下面指令:

    appledoc --project-name "项目名字" --project-company "公司名字" ./ 需要扫描的路径

    (3) 项目目录下会生成一个docset-installed.txt文件,打开文本,复制里面path,通过“前往文件夹”进入路径目标,找到对应的.docset文件,通过显示包内容,获取里面的API文档。Contents->Resources->Documents

    相关文章

      网友评论

          本文标题:xcode自动导出API文档

          本文链接:https://www.haomeiwen.com/subject/tmasuftx.html