亲测可用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

使用：重点来拉，认真执行下面这三个步骤就行，看清截图

• 一、建立一个Xcode项目，项目名：demo，并建立一个文件测试生成文档；
• 二、cd 到项目文件夹；
• 三、执行终端命令
  具体步骤：

• 一、建立一个Xcode项目，项目名：demo，并建立一个文件测试生成文档：

  
  
  

  SoundBusTool类
• 二、cd 到项目文件夹：

cd 到项目的文件夹
复制代码

项目目录

• 三、执行终端命令

$ 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

本人的一点开发小记，若是对你有帮助欢迎小❤️❤️，另不吝赐教。

小编这呢，给你们推荐一个优秀的iOS交流平台，平台里的伙伴们都是很是优秀的iOS开发人员，咱们专一于技术的分享与技巧的交流，你们能够在平台上讨论技术，交流学习。欢迎你们的加入（想要加入的可加小编微信15673450590）。

做者：pengshuangta 连接：https://www.jianshu.com/p/44f51e483508#comments