亲测可用iOS开发appledoc工具安装使用体验

前言:

demo地址

网上很多关于appledoc的使用,要么比较久的,要么讲解的不是很清晰,按照他们的步骤执行没成功,so,根据自己安装使用成功和遇到的问题,记录一下:
背景:
项目源码交接给另外一个公司的开发人员,需要为他们提供app大致的使用文档,CTO问:你们是否有类似java的javadoc源码文档工具,百度了一下:答案是有的,iOS也有appledoc,而且appledoc最后生成一个indxe.html文件,打开index.html文件会显示iOS官方API一样风格的文档,是不是还蛮棒棒的!
体验:
安装:打开终端一步步执行下面的命令
$ git clone git://github.com/tomaz/appledoc.git
$ cd ./appledoc
$ sudo sh install-appledoc.sh
验证:安装是否成功
# 查看版本,如果显示版本,则证明安装成功
$ appledoc --version
# 查看appledoc的命令
$ appledoc --help
appledoc --version
使用:重点来拉,认真执行下面这三个步骤就行,看清截图
  • 1、创建一个Xcode项目,项目名:demo,并创建一个文件测试生成文档;
  • 2、cd 到项目文件夹;
  • 3、执行终端命令
    具体步骤:
  • 1、创建一个Xcode项目,项目名:demo,并创建一个文件测试生成文档:


    SoundBusTool类
  • 2、cd 到项目文件夹:
cd 到项目的文件夹
项目目录
  • 3、执行终端命令
$ appledoc --no-create-docset --output="./doc" --project-name="工程名" --company-id="bundle id" --project-company="公司名" .
执行终端命令

打开index.html文件

查看文档
遇到的两个问题:
  • 问题1:执行终端命令doc文件夹下没有生成index.html文件,原因是:没有给Xcode创建的demo项目写注释,解决,如果我在appdelegate.h中,随便给方法添加一个注释,然后在执行终端命令就能成功生成index.html文件;


    问题1错误提示docsetutil:

    解决1
  • 问题2:在原来的项目中,执行命令,没有生成doc文件夹;


    问题2错误提示:Invalid parameter not satisfying: [arguments count] >= 1

    解决2
靠谱的参考:

参考链接1
参考链接2
本人的一点开发小记,如果对你有帮助欢迎小❤️❤️,另不吝赐教。