美文网首页
使用AppleDoc快速生成iOS开发文档

使用AppleDoc快速生成iOS开发文档

作者: MrSYLong | 来源:发表于2019-07-15 12:48 被阅读0次

    今天需要重新导出项目工程开发文档,但导出生成的html有问题:
    1、没有css样式(生成html文档的/html/css路径下都没有style.css文件)
    2、进入某个类的文档界面,没有任何API内容

    创建测试工程,使用AppleDoc导出html文档,在浏览器打开,存在一样的问题。

    搜索问题发现我的AppleDoc是:
    appledoc version: 2.2.1 (build 1333)
    而其他人的版本已经是:
    appledoc version: 2.2.1 (build 1334)

    于是使用命令先卸载AppleDoc:
    sudo brew install appledoc
    然后使用命令重新进行安装:

    $ git clone git://github.com/tomaz/appledoc.git
    $ cd ./appledoc
    $ sudo sh install-appledoc.sh
    

    当出现 INSTALL SUCCEEDED 时说明成功了。

    重新对项目工程使用命令导出文档:

    appledoc --no-create-docset --output ./doc --project-name "项目名称" --project-company "公司名称" --company-id "公司id" .
    

    结果成功,没有之前的问题。

    结论:
    macOS MoJave 10.14.1 (18B75)
    Xcode Version 10.1 (10B61)
    使用appledoc version: 2.2.1 (build 1333)
    导出文档可能会出现问题,可以卸载重新安装

    参考链接:
    https://www.jianshu.com/p/fd4d8d6b6177
    https://superdanny.link/2018/06/19/iOS-AppleDoc/

    相关文章

      网友评论

          本文标题:使用AppleDoc快速生成iOS开发文档

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